|
| 1 | +# Contributing to Eclipse EdiTDor |
| 2 | + |
| 3 | +Any contribution to this project is welcome. |
| 4 | +If you want to report a bug or question, please check the [issue list](https://github.com/eclipse/editdor/issues) or create a new issue. |
| 5 | +If you want to contribute to this project by coding, please fork the repository and then follow the general contribution guidelines described [here](https://github.com/firstcontributions/first-contributions/blob/master/README.md). |
| 6 | +However, EdiTDor is an [Eclipse IoT](https://iot.eclipse.org) project and as such is governed by the Eclipse Development process. |
| 7 | +This process helps us in creating great open source software within a safe legal framework. |
| 8 | + |
| 9 | +Thus, before your contribution can be accepted by the project team, contributors must electronically sign the [Eclipse Contributor Agreement (ECA)](http://www.eclipse.org/legal/ECA.php) and follow these preliminary steps: |
| 10 | + |
| 11 | +- Obtain an [Eclipse Foundation account](https://accounts.eclipse.org/) |
| 12 | + - Anyone who currently uses Eclipse Bugzilla or Gerrit systems already has one of those |
| 13 | + - Newcomers can [create a new account](https://accounts.eclipse.org/user/register?destination=user) |
| 14 | +- Add your GiHub username to your Eclipse Foundation account |
| 15 | + - ([Log into Eclipse](https://accounts.eclipse.org/)) |
| 16 | + - Go to the _Edit Profile_ tab |
| 17 | + - Fill in the _GitHub ID_ under _Social Media Links_ and save |
| 18 | +- Sign the [Eclipse Contributor Agreement](http://www.eclipse.org/legal/ECA.php) |
| 19 | + - ([Log into Eclipse](https://accounts.eclipse.org/)) |
| 20 | + - If the _Status_ entry _Eclipse Contributor Agreement_ has a green checkmark, the ECA is already signed |
| 21 | + - If not, go to the _Eclipse Contributor Agreement_ tab or follow the corresponding link under _Status_ |
| 22 | + - Fill out the form and sign it electronically |
| 23 | +- Sign-off every commit using the same email address used for your Eclipse account |
| 24 | + - Set the Git user email address with `git config user.email "<your Eclipse account email>"` |
| 25 | + - Add the `-s` flag when you make the commit(s), e.g. `git commit -s -m "feat: add support for magic"` |
| 26 | +- Open a [Pull Request](https://github.com/eclipse/editdor/pulls) |
| 27 | + |
| 28 | +For more information, please see the Eclipse Committer Handbook: |
| 29 | +https://www.eclipse.org/projects/handbook/#resources-commit |
0 commit comments