Permalink
Browse files

Link to a rebase howto and motivation for why rebase is preferred

  • Loading branch information...
1 parent 7fa1cd2 commit 2f3604ab22c47d97e5ae5872cbf6bf96bf2c2470 @betatim betatim committed Mar 20, 2016
Showing with 8 additions and 5 deletions.
  1. +8 −5 CONTRIBUTING.md
View
@@ -43,15 +43,18 @@ and click 'Pull request' to send your changes to the maintainers for
review. This will send an email to the committers. A valid PR includes review. This will send an email to the committers. A valid PR includes
the following items: the following items:
-* a description of the problem you are solving or reference to existing issue +* a description of the problem you are solving or reference to an existing issue
* a discussion why you made the choices you made * a discussion why you made the choices you made
* contains the minimal set of changes needed to solve the problem (do * contains the minimal set of changes needed to solve the problem (do
not mix several issues, rather create separate PRs) not mix several issues, rather create separate PRs)
* unit and frontend tests for your changes * unit and frontend tests for your changes
* the code should follow the style of the project * the code should follow the style of the project
* the code should contain documentation in the form of docstrings * the code should contain documentation in the form of docstrings
and comments and comments
-* no commits merging master into your branch, instead rebase your branch +* [do not merge master]
+ (https://www.atlassian.com/git/tutorials/merging-vs-rebasing/conceptual-overview)
+ into your feature branch, instead [rebase your branch]
+ (https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request).
These are guidelines and not hard rules, so if you feel one of them does not These are guidelines and not hard rules, so if you feel one of them does not
apply, write a short sentence in the PR's description explaining why you apply, write a short sentence in the PR's description explaining why you
@@ -67,11 +70,11 @@ We prefer "getting it right" and having a maintainable project over chasing
features or doing things in a hurry. features or doing things in a hurry.
Expect to get feedback and suggestions for improvement. This is not a sign that Expect to get feedback and suggestions for improvement. This is not a sign that
-you are stupid, instead it shows the others care about your changes and want to +you are stupid, instead it shows the others care about your changes, want to
make them better and help you out with things you missed. make them better and help you out with things you missed.
-There is one additional rule: no one can merge their own pull requests, someone +**There is one additional rule:** no one can merge their own pull requests,
-else has to press the button. +someone else has to press the button.
[issues]: https://github.com/everware/everware/issues [issues]: https://github.com/everware/everware/issues
[license]: LICENSE [license]: LICENSE

0 comments on commit 2f3604a

Please sign in to comment.