diff options
author | Matthias Sohn | 2014-09-02 14:40:05 +0000 |
---|---|---|
committer | Matthias Sohn | 2014-09-02 14:40:05 +0000 |
commit | 5deca3b2e4833c8fe5dcb7db46d8cf758a2402d9 (patch) | |
tree | bcea7c1ed9a526e5bb69ab26fd29a22e6da76dfe /CONTRIBUTING.md | |
parent | 7fc22aa1b19d5b8eb9f4bfb9c4fca76e3b634ef3 (diff) | |
download | egit-github-5deca3b2e4833c8fe5dcb7db46d8cf758a2402d9.tar.gz egit-github-5deca3b2e4833c8fe5dcb7db46d8cf758a2402d9.tar.xz egit-github-5deca3b2e4833c8fe5dcb7db46d8cf758a2402d9.zip |
Add CONTRIBUTING.md for the github connector
Bug: 397644
Change-Id: I0be68ef8a85d2ce3323d16f2f384d131f2102b4b
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
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 00000000..57989b5e --- /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/GitHub/ContributorGuide + + +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=EGit&component=GitHub + + +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/egit/egit-github.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 :). |