Skip to content

Commit 23c72ee

Browse files
committed
added CONTRIBUTING.md
1 parent 443ead1 commit 23c72ee

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Guide to contributing
2+
3+
Please read this if you intend to contribute to the project.
4+
5+
## First things
6+
7+
* Get a github account if you don't have one already
8+
* Submit a github issue if there isn't one already.
9+
* Clearly describe the bug or feature
10+
* Provide exact reproducable steps to reproduce the issue if its a bug
11+
* Include the versions of all components
12+
* Fork the repository on github
13+
14+
## Making your changes
15+
16+
* Create a new branch for your changes
17+
* Make your changes
18+
* Make sure you include tests
19+
* Make sure the test suite passes after your changes
20+
* Commit your changes into that branch
21+
* Use descriptive and meaningful commit messages
22+
* If you have a lot of commits squash them into a single commit
23+
* Push your changes to your branch in your forked repository
24+
25+
## Submitting the changes
26+
27+
Before submitting your pull request you must sign the [Eclipse Foundation Contributor License Agreement](http://www.eclipse.org/legal/CLA.php).
28+
29+
We will NOT ACCEPT any contributions without this first being signed.
30+
31+
To sign the Eclipse CLA you need to:
32+
33+
* Obtain an Eclipse Foundation userid. Anyone who currently uses Eclipse Bugzilla or Gerrit systems already has one of those.
34+
If you don’t, you need to [register](https://dev.eclipse.org/site_login/createaccount.php).
35+
36+
* Login into the [projects portal](https://projects.eclipse.org/), select “My Account”, and then the “Contributor License Agreement” tab.
37+
38+
## After submitting
39+
40+
* Once you have signed the Eclipse CLA, make a note on the github issue that you have signed the CLA, and then you can submit a pull request via github.
41+
* Do not use your branch for any other development, otherwise further changes that you make will be visible in the PR.
42+
43+
44+

0 commit comments

Comments
 (0)