Our Rails style guide can be found here.
IMPORTANT: Make sure to set your git information. Instructions can be found here.
Developer workflow is as follows:
- Make sure your master branch is up-to-date:
git checkout master
git pull
- Checkout a new branch off of master. Name the branch in the following manner:
git checkout -b <your_name>/<your_feature>
- Create a GitHub issue for your feature in the DREAM repository so that other engineers know what you are working on.
- Implement your new feature.
- Create a pull request. Make sure to edit the pull request title to align with your feature. In the description, you should generally write a small 1-2 line description of what you completed. Then, on separate new lines, indicate which issues you closed with this pull request with the following syntax:
Fix #104
Fix #105
- Push your code:
git push origin <your_branch_name>. Submit your pull request and another engineer will review your code and discuss with you the changes you made if necessary. - Before merging your branch, make sure that your branch is up-to-date with head. You can do
this by choosing option
squash and mergewhen merging pull request on GitHub. When merging in a pull request, the issues indicated in the description are automatically closed. If you are the one merging in the pull request, make sure to delete the branch! (you can do this on the pull request itself). - Rinse and repeat! Thank you for contributing to DREAM!