These guidelines are a living document and are intended to make contributing to Hack Reactor projects a more pleasant experience for everyone. As such, it's expected to change over time. If there's anything that would help make your work easier or more efficient, please submit a pull request.
Files should encaspulate a single conceptual idea. Files should be named following the same format as commit messages.
- Fork the repo
- Create a feature branch, namespaced by.
- bug/...
- feat/...
- test/...
- doc/...
- refactor/...
- Make commits to your feature branch. Prefix each commit like so:
- (feat) Added a new feature
- (fix) Fixed inconsistent tests [Fixes #0]
- (refactor) ...
- (cleanup) ...
- (test) ...
- (doc) ...
- When you've finished with your fix or feature, submit a pull request directly to master. Include a description of your changes.
- Your pull request's build status will appear on the pull request page. If your build fails, click 'Details' to find out why and fix the issue.
- Assign a task to your code reviewer in Asana. Include a link to the pull request.
- Your pull request will be reviewed by another maintainer. The point of code reviews is to help keep the codebase clean and of high quality and, equally as important, to help you grow as a programmer. If your code reviewer requests you make a change you don't understand, ask them why.
- Fix any issues raised by your code reviwer, and push your fixes as a single new commit.
- Once the pull request has passed CI and review, it can be merged.
- Uphold the current code standard:
- Keep your code DRY.
- Apply the boy scout rule.
- Follow Hack Reactor's style guide.
- Run the tests before submitting a pull request.
- Tests are very, very important. Submit tests if your pull request contains new, testable behavior.
- Your pull request is comprised of a single (squashed) commit.