Skip to content

Commit a87ff26

Browse files
authored
Merge pull request #101 from egekorkan/patch-3
Create CONTRIBUTING.md
2 parents 85f363a + 0467b0c commit a87ff26

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The goal of this project is the easy creation of W3C Thing Description instances
3030
- TailwindCSS
3131

3232
## Contribution guide
33-
Any contribution to this project is welcome. 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. If you want to contribute to this project by coding, please follow the general contribution guidelines described [here](https://github.com/firstcontributions/first-contributions/blob/master/README.md). Note that you need to have an Eclipse account to make Pull Requests.
33+
Please follow our [contribution guide](./CONTRIBUTING.md).
3434

3535
## License
3636
* [Eclipse Public License v. 2.0](http://www.eclipse.org/legal/epl-2.0)

0 commit comments

Comments
 (0)