diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d5f61e9e..795699f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ If you are joining the project from the previous repository at admin-shell-io/aa 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. -## Migrating +## Joining Development AASX Package Explorer is an Eclipse Foundation incubated project and therefore needs to adhere to Eclipse Foundation rules. This introduces a slight overhead for every contributor, at least at the very begginning, but it's worth it! @@ -23,10 +23,100 @@ Here are the steps to begin contributing to the Eclipse AASX Package Explorer (a 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) -### +## General development guidelines -## Contribution guidelines - -tbd +tbd: +- disabled projects - pipelining/admin/configuration +- releases + +### How to contribute + +Mechanics of how to actually contribute (e.g., merge/pull requests) are described in [AASX Project Explorer Devdoc](https://admin-shell-io.github.io/aasx-package-explorer/devdoc/getting-started/intro.html). + +To help you familiarize with the concept of Asset Administration Shell we provide the screencasts (both in English and German) at: https://admin-shell-io.com/screencasts/. + +For further information about the Asset Administration Shell, see the publication Details of the Asset Administration Shell by Plattform Industrie 4.0. + +We provide a couple of sample admin shells (packaged as .aasx) for you to test and play with the software at: http://www.admin-shell-io.com/samples/ + +### Terms of Use + +This Eclipse Foundation open project is governed by the Eclipse Foundation +Development Process and all its source code as well as the released binaries are subject to Eclipse Foundation’s Terms of Use, available at https://www.eclipse.org/legal/termsofuse.php. + +### Communication + +Communication between contributors takes place predominantly through project issues and repository mailing list: TBD + +### Repositories + +Source code is publically available in the https://github.com/eclipse-aaspe/aaspe repository. + +### ECA + +Contributors are required to electronically sign the Eclipse Contributor Agreement (https://www.eclipse.org/legal/ECA.php) to contribute to Eclipse AASX Package Explorer™. + +Commits that are provided by non-committers must contain a Signed-off-by field in +the footer indicating that the author is aware of the terms by which the +contribution has been provided to the project. The non-committer must +additionally have an Eclipse Foundation account and must have a signed Eclipse +Contributor Agreement (ECA) on file. + + +## Eclipse sources - useful links + +##### Development process + +https://www.eclipse.org/projects/dev_process/ + +Overview/flowchart of the whole process +https://www.eclipse.org/projects/dev_process/#6_Development_Process + +##### Project handbook + +https://www.eclipse.org/projects/handbook/ + +Starting an OS project with Eclipse Foundation +https://www.eclipse.org/projects/handbook/#starting + +User roles (User/Committer/Project Lead/Project Management Committee) +https://www.eclipse.org/projects/handbook/#roles + +Intellectual property +https://www.eclipse.org/projects/handbook/#ip + +Releases +https://www.eclipse.org/projects/handbook/#release + +##### Development resources + +https://wiki.eclipse.org/Development_Resources + +Getting started +https://wiki.eclipse.org/Development_Resources#Projects:_Getting_Started + +Incubation phase +https://wiki.eclipse.org/Development_Resources/HOWTO/Incubation_Phase + +##### Eclipsepedia + +https://wiki.eclipse.org/Main_Page + +FAQs +https://wiki.eclipse.org/The_Official_Eclipse_FAQs + +IP stuff +https://wiki.eclipse.org/IP_Stuff + +##### Misc + +Legal: committer “due diligence” guidelines +https://www.eclipse.org/legal/committerguidelines.php + +Project management infrastructure +https://wiki.eclipse.org/Project_Management_Infrastructure + +Forges (community of communities) +https://wiki.eclipse.org/Forges