Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readme warning #2

Merged
merged 7 commits into from
Dec 13, 2023
Merged

Readme warning #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c9329e5
Create CONTRIBUTING
martafullen Dec 8, 2023
a5d0c5b
Migration notice
martafullen Dec 8, 2023
d20767f
CONTRIBUTING stub
martafullen Dec 8, 2023
d29c2af
CONTRIBUTING draft update
martafullen Dec 8, 2023
c7c2f66
CONTRIBUTING now identifies as an .md
martafullen Dec 8, 2023
0019a63
Update README.md
martafullen Dec 9, 2023
f5a4a3f
Update README.md
AlexanderWollbrink Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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](
Expand Down
Loading