diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d5f61e9e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing + +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. + +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 + +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! + +Here are the steps to begin contributing to the 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 + + or... + +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) + +### + +## Contribution guidelines + +tbd + +- pipelining/admin/configuration diff --git a/README.md b/README.md index 41569aca..9a17b12f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,13 @@ -# AASX Package Explorer +> [!NOTE] +> Welcome to the new home of **Eclipse AASX Package Explorer**, previously at [admin-shell-io/aasx-package-explorer](https://github.com/admin-shell-io/aasx-package-explorer). +> All the development has been moved here and the admin-shell-io repository will be archived. +> See [CONTRIBUTING](CONTRIBUTING) for details on how to migrate your development. + +> [!IMPORTANT] +> Current development of AASX Package Explorer only supports AAS V3. +> If you need to view AAS V2 files, see the branch [here](https://github.com/eclipse-aaspe/aaspe/tree/V2). + +# Eclipse AASX Package Explorerâ„¢ ![Build-test-inspect]( https://github.com/admin-shell-io/aasx-package-explorer/actions/workflows/build-test-inspect.yml/badge.svg @@ -28,7 +37,7 @@ https://admin-shell-io.github.io/aasx-package-explorer/todos/badges/HACKs.svg https://github.com/admin-shell-io/aasx-package-explorer/blob/gh-pages/todos/task-list/task-list-by-file.md ) -AASX Package Explorer is a C# based viewer / editor for the +Eclipse AASX Package Explorerâ„¢ is a C# based viewer and editor for the Asset Administration Shell. ![screenshot](