diff options
author | Robin Stocker <robin@nibor.org> | 2014-07-19 14:59:12 +1000 |
---|---|---|
committer | Chris Aniszczyk <caniszczyk@gmail.com> | 2014-07-20 17:44:53 -0400 |
commit | f3fc3797579ac0bf55648bad560e7daa5e6df9b5 (patch) | |
tree | d09b389888e40cb7a22ab53dff9b2540f8ef225e /CONTRIBUTING.md | |
parent | fd58cbcdee632100f239423194be9aaa951f7835 (diff) | |
download | jgit-f3fc3797579ac0bf55648bad560e7daa5e6df9b5.tar.gz jgit-f3fc3797579ac0bf55648bad560e7daa5e6df9b5.zip |
Update SUBMITTING_PATCHES
It contained outdated information about attaching patches to bug
reports. Shorten it to the essentials.
Also format it using markdown and rename it to CONTRIBUTING.md, which is
a convention and doesn't include "patches" in the name.
Change-Id: I9ee73f16e6fa8fbf529ac0ca791e2375d4d56d68
Signed-off-by: Robin Stocker <robin@nibor.org>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..4818589ff7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +Contributing +============ + +Please refer to the contributor guide for all the details: + +https://wiki.eclipse.org/EGit/Contributor_Guide + + +Reporting bugs +-------------- + +For anything other than small changes, it's a good idea to open a bug +report for it (in case one doesn't already exist). This gives others the +chance to give input and is useful for tracking. Create one here: + +https://bugs.eclipse.org/bugs/enter_bug.cgi?product=JGit + + +Submitting changes +------------------ + +We use Gerrit to review all changes by committers or contributors before +they are merged: + +https://git.eclipse.org/r/ + +Make sure you have an account and have set up the `commit-msg` hook +before committing. + +When committing your changes, see the contributor guide or other commits +on what your commit message should include. + +Run the following to push your change for review (with `username` +replaced by your Gerrit username): + + git push ssh://username@git.eclipse.org:29418/jgit/jgit.git HEAD:refs/for/master + +Add the link to the review as a comment on the bug report, so that +people coming from the bug report can find it. + +Then wait for someone to review your change. If there is something to be +corrected, amend your commit and push it again. + +Have fun :). |