Skip to content

Latest commit

 

History

History
31 lines (27 loc) · 1.56 KB

README.md

File metadata and controls

31 lines (27 loc) · 1.56 KB

Windsor Hackforge Software Development Guidelines

Coding Practices

  • Don't be too clever; readability is #1
  • Check available libraries for a solution to your problem
  • If you must do something weird, explain with a comment
  • If the code does something obvious, please do NOT explain with a comment

Style Guides

Contributing - Fork & Pull Request

  • Fork the repository, make your changes in your own github repo, and submit a Pull Request
  • Clearly label your PR with a short title that describes the issue you are addressing or the feature you are implementing
  • The body of your PR description should include a concise, bullet-point list of your changes
  • When a PR has been given the "thumbs up" by at least two other developers, a lead developer will merge your commits
  • Please do not merge your own PRs, even if you are a lead developer
  • if a project's lead developers are not available, or if YOU are the lead, a Hackf Admin (Doug Sartori, Jeff Szusz or Randy Topliffe) can review and merge your PR

If your fork is out of date, [sync it with the upstream repo] (https://help.github.com/articles/syncing-a-fork)