xref: /JGit/CONTRIBUTING.md (revision ee01bbca22f8c75355af081046fa5923c88bc488)
1# Contributing
2
3Please refer to the [contributor guide](https://wiki.eclipse.org/EGit/Contributor_Guide) for all the details.
4Contributions require that you sign the [Eclipse Contributor Agreement](https://www.eclipse.org/legal/ECA.php).
5
6## Reporting bugs
7
8For anything other than small changes, it's a good idea to open a bug
9report for it (in case one doesn't already exist). This gives others the
10chance to give input and is useful for tracking.
11[Create JGit bugs here](https://bugs.eclipse.org/bugs/enter_bug.cgi?product=JGit).
12
13## Submitting changes
14
15- We use [Gerrit](https://git.eclipse.org/r/) to review all changes by committers
16or contributors before they are merged.
17- Make sure you have an account and have set up the `commit-msg` hook
18before committing.
19- When committing your changes, see the contributor guide or other commits
20on what your commit message should include.
21- Run the following to push your change for review (with `username`
22replaced by your Gerrit username):
23
24```bash
25git push ssh://username@git.eclipse.org:29418/jgit/jgit.git HEAD:refs/for/master
26```
27
28- Add the link to the review as a comment on the bug report, so that
29people coming from the bug report can find it.
30- Then wait for someone to review your change. If there is something to be
31corrected, amend your commit and push it again.
32
33Have fun :).
34