-
Notifications
You must be signed in to change notification settings - Fork 255
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update contribution guidelines and make github display them
Try to make it clear that sloppy, throw it over the fence, patches won't be accepted without revision and try to make sure a potential contributor sees the warning while creating a pull request.
- Loading branch information
Showing
2 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
When submitting a patch make sure the commits in your pull request: | ||
|
||
* Have good commit messages | ||
|
||
Please read Chris Beams' blog post [How to Write a Git Commit | ||
Message](https://chris.beams.io/posts/git-commit/) on how to write a | ||
good commit message. Although the article recommends at most 50 | ||
characters for the subject, up to 72 characters are frequently | ||
accepted for fast-export. | ||
|
||
* Adhere to good [commit | ||
hygiene](http://www.ericbmerritt.com/2011/09/21/commit-hygiene-and-git.html) | ||
|
||
When developing a pull request for hg-fast-export, base your work on | ||
the current `master` branch and rebase your work if it no longer can | ||
be merged into the current `master` without conflicts. Never merge | ||
`master` into your development branch, rebase if your work needs | ||
updates from `master`. | ||
|
||
When a pull request is modified due to review feedback, please | ||
incorporate the changes into the proper commit. A good reference on | ||
how to modify history is in the [Pro Git book, Section | ||
7.6](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History). | ||
|
||
Please do not submit a pull request if you are not willing to spend | ||
the time required to address review comments or revise the patch until | ||
it follows the guidelines above. A _take it or leave it_ approach to | ||
contributing wastes both your and the maintainer's time. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters