diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 203e938015..6d464973d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ If you are not familiar with Rubocop, spend some time studying their page and a 4. Please add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need -a test! We use [Minitest](https://github.com/seattlerb/minitest) in this project. If you're not familiar with Minitest and are comfortable with Rspec, please ask a collaborator to review your PR. +a test! We use [Minitest](https://github.com/seattlerb/minitest) in this project. If you're not familiar with Minitest and are comfortable with Rspec, please ask a contributor/collaborator to review your PR. 5. Make the test pass. Always use `sample`, `shuffle`, and `rand` from the Base class (just like the rest of the code) rather than @@ -34,32 +34,19 @@ arguments. An exception to this could be a method that takes only one optional argument, and it's unlikely that that method would ever take more than one optional argument. -8. If you need to update your branch with master before merging, you should follow these steps: -```ruby -# GitHub ID: vbrazo -# Branch: fixes/fix-warnings +8. Push to your fork and submit a pull request. -git remote -v # Show all Remote Branches -git remote add faker git@github.com:stympy/faker.git # if you don't have the faker remote address yet -git checkout master # switch to the master branch -git reset --hard HEAD~50 # because your branch master might have things that don't need anymore -git pull faker master # now you're good to go -git push -f [your remote address] master # now your master is updated -# in this case it would be git push -f vbrazo master +### Github Flow -# if you want to update your fixes/fix-warnings branch after updating your master: -git checkout fixes/fix-warnings -git merge --no-ff master -git status # to see what files have conflicts. Fix the conflicts and commit them -git add . -git commit -m 'Fix merge conflicts with master' -git push -f [your remote address] fixes/fix-warnings -# in this case it would be git push -f vbrazo fixes/fix-warnings -``` +For those of you with commit access, please check out Scott Chacon's blog post about [github flow](http://scottchacon.com/2011/08/31/github-flow.html) -8. Push to your fork and submit a pull request. +> * Anything in the master branch is deployable +> * To work on something new, create a descriptively named branch off of master (ie: new-oauth2-scopes) +> * Commit to that branch locally and regularly push your work to the same named branch on the server +> * When you need feedback or help, or you think the branch is ready for merging, open a pull request +> * After someone else has reviewed and signed off on the feature, you can merge it into master -Syntax: +Syntax/Good practices: * Two spaces, no tabs. * No trailing whitespace. Blank lines should not have any space.