diff options
| author | Matthias Sohn <matthias.sohn@sap.com> | 2021-06-15 13:59:23 +0200 |
|---|---|---|
| committer | Matthias Sohn <matthias.sohn@sap.com> | 2021-06-15 14:00:08 +0200 |
| commit | 45b16ebcc152944d7474ed9d6a36a70b4d9e582f (patch) | |
| tree | 6a6542c53d63c7baf1537ba82c6763fcfc6a2a47 /CONTRIBUTING.md | |
| parent | 5a232c9509cc4035dad8490b0d9cd790b49c75ae (diff) | |
| download | jgit-45b16ebcc152944d7474ed9d6a36a70b4d9e582f.tar.gz jgit-45b16ebcc152944d7474ed9d6a36a70b4d9e582f.zip | |
CONTRIBUTING: Use standard markdown format
Change-Id: Ic64a62ca29950fb6a4c3c8a31bee8173c005ea4e
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 44 |
1 files changed, 16 insertions, 28 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4818589ff7..2fc3550011 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,44 +1,32 @@ -Contributing -============ +# Contributing -Please refer to the contributor guide for all the details: +Please refer to the [contributor guide](https://wiki.eclipse.org/EGit/Contributor_Guide) for all the details. -https://wiki.eclipse.org/EGit/Contributor_Guide - - -Reporting bugs --------------- +## 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 ------------------- +chance to give input and is useful for tracking. +[Create JGit bugs here](https://bugs.eclipse.org/bugs/enter_bug.cgi?product=JGit). -We use Gerrit to review all changes by committers or contributors before -they are merged: +## Submitting changes -https://git.eclipse.org/r/ - -Make sure you have an account and have set up the `commit-msg` hook +- We use [Gerrit](https://git.eclipse.org/r/) to review all changes by committers +or contributors before they are merged. +- 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 +- 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` +- 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 +```bash +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 +- 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 +- Then wait for someone to review your change. If there is something to be corrected, amend your commit and push it again. Have fun :). |