Martaf/contributing (#19)

* Update CONTRIBUTING.md

* Update README.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update README.md

* Update README.md

CONTRIBUTING.md

@@ -2,31 +2,125 @@
 
 Welcome to the Eclipse AASX Package Explorer repository. 
 
-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.
+Whether you're new to the project or joining from the previous repository at admin-shell-io, please see the [Joining Development](#joining-development) section below to get started in the new repository.
 
 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!
+This introduces a slight overhead for every contributor, at least at the very beginning, but it's worth it!
 
-Here are the steps to begin contributing to the Eclipse AASX Package Explorer (and any other project under the Eclipse Foundation umbrella):
+Follow these steps to become a Contributor in Eclipse AASX Package Explorer (and any other project under the Eclipse Foundation umbrella):
 
-1. create an account at the Eclipse Foundation website
-    - make sure to add your github name
-1. become a Contributor to Eclipse AASX Package Explorer
-1. pull request
-1. happily develop ever after
+1. Create an Eclipse Foundation Account at https://accounts.eclipse.org/ 
+1. Log in to your Eclipse account and digitally sign the [Eclipse Contributor Agreement](https://www.eclipse.org/projects/handbook/#contributing-eca);
+1. Make sure to add your github name (`Edit my account` > `Social Media Links` > `GitHub Username`)
+1. Clone or fork the repository and create an initial commit
+    - if you have preexisting work that you'd like to include, see TBD
+    - ensure that the author credentials on the commit record match the email address and/or GitHub username associated with the Eclipse Foundation Account
+1. Create a pull request and work with the project team to merge the contribution
+    - your request will need to be reviewed and approved by an Eclipse Contributor (GitHub Maintainer role) 
+1. Happily develop ever after!
+    - 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)
 
-      or...
+For more details see ["Contributing" in Eclipse Foundation Handbook](https://www.eclipse.org/projects/handbook/#contributing-contributors).
+
+## General development guidelines
 
-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)
+tbd:
 
-### 
+- disabled projects
+- dependencies
+- pipelining/admin/configuration
+- releases
 
-## Contribution guidelines
+### How to contribute
 
-tbd
+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).
 
-- pipelining/admin/configuration
+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 

README.md

@@ -1,6 +1,6 @@
 > [!NOTE]
 > Welcome to the new home of **Eclipse AASX Package Explorer**!
-> See [CONTRIBUTING](CONTRIBUTING) for details on how to migrate your development.
+> See [CONTRIBUTING](CONTRIBUTING.md) for details on how to migrate your development.
 
 > [!IMPORTANT]
 > Current development of AASX Package Explorer only supports AAS V3.  
@@ -72,13 +72,11 @@ https://github.com/admin-shell-io/aasx-package-explorer/issues/new/choose).
 
 ## Contributing
 
-The latest documentation for developers is available [on this page](
-https://admin-shell-io.github.io/aasx-package-explorer/devdoc/
-).
+Please see [CONTRIBUTING](CONTRIBUTING.md) for instructions on joining the development and general contribution guidelines.
 
-If you want to contribute in code, see [Section "Getting started"](
-https://admin-shell-io.github.io/aasx-package-explorer/devdoc/getting-started/intro.html
-).
+The documentation for developers is still available at [admin-shell-io](
+https://admin-shell-io.github.io/aasx-package-explorer/devdoc/
+) and will be migrated to eclipse-aaspe in the near future. 
 
 ## Other Open Source Implementations of AAS
 
@@ -112,5 +110,5 @@ shells targeting tech-savvy and less technically-inclined users alike.
 The AASX Package Explorer also includes an internal REST server and OPC UA
 server for the loaded .AASX. Based on this a separate AASX Server is
 available (https://github.com/admin-shell-io/aasx-server) which can host
-several .AASX simultanously (see example https://admin-shell-io.com/5001/).
+several .AASX simultaneously (see example https://example.admin-shell-io.com).