Skip to content

Commit 8c1bacc

Browse files
authored
Update CONTRIBUTING.md
1 parent e39db18 commit 8c1bacc

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

CONTRIBUTING.md

+18-15
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,35 @@
22

33
Welcome to the Eclipse AASX Package Explorer repository.
44

5-
If you are joining the project from the previous repository at admin-shell-io/aasx-package-explorer, please see the [Migrating](#migrating) section below to get started in the new repository.
5+
If you are joining the project from the previous repository at admin-shell-io/aasx-package-explorer, please see the [Joining Development](#joining-development) section below to get started in the new repository.
66

77
The [Contribution guildelines](#contribution-guidelines) section includes general guidelines as well as additional quirks specific to Eclipse Foundation projects, so it is definitely worth a read as well.
88

99
## Joining Development
1010

1111
AASX Package Explorer is an Eclipse Foundation incubated project and therefore needs to adhere to Eclipse Foundation rules.
12-
This introduces a slight overhead for every contributor, at least at the very begginning, but it's worth it!
13-
14-
Here are the steps to begin contributing to the Eclipse AASX Package Explorer (and any other project under the Eclipse Foundation umbrella):
15-
16-
1. create an account at the Eclipse Foundation website
17-
- make sure to add your github name
18-
1. become a Contributor to Eclipse AASX Package Explorer
19-
1. pull request
20-
1. happily develop ever after
21-
22-
or...
23-
24-
4. contact a Project Lead or a Committer to be nominated to a Committer yourself (and receive more repository priviledges, such as ability to merge)
25-
12+
This introduces a slight overhead for every contributor, at least at the very beginning, but it's worth it!
13+
14+
Here are the steps to become a Contributor in Eclipse AASX Package Explorer (and any other project under the Eclipse Foundation umbrella):
15+
16+
1. Create an Eclipse Foundation Account at https://accounts.eclipse.org/
17+
1. Log in to your Eclipse account and digitally sign the [Eclipse Contributor Agreement](https://www.eclipse.org/projects/handbook/#contributing-eca);
18+
1. Make sure to add your github name (`Edit my account` > `Social Media Links` > `GitHub Username`)
19+
1. Fork the repository and create an initial commit
20+
- if you have preexisting work that you'd like to include, see TBD
21+
- ensure that the author credentials on the commit record match the email address and/or GitHub username associated with the Eclipse Foundation Account
22+
1. Create a pull request and work with the project team to merge the contribution
23+
1. Happily develop ever after!
24+
- or contact a Project Lead or a Committer to be nominated to a Committer yourself (and receive more repository priviledges, such as the ability to merge)
25+
26+
For more details see ["Contributing" in Eclipse Foundation Handbook](https://www.eclipse.org/projects/handbook/#contributing-contributors).
27+
2628
## General development guidelines
2729

2830
tbd:
2931

3032
- disabled projects
33+
- dependencies
3134
- pipelining/admin/configuration
3235
- releases
3336

0 commit comments

Comments
 (0)