Skip to content

Commit 9631760

Browse files
festo-i40festo-i40
committed
* merging with main
2 parents df603bd + f8fbc4d commit 9631760

File tree

125 files changed

+5944
-9157
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+5944
-9157
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
4+
title: "[BUG]"
5+
labels: bug
66
assignees: ''
77

88
---

‎.gitignore

+7-5
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,10 @@ sample-aasx/
2525
/src/BlazorUI/09_SchneiderElectric.aasx
2626
/.vs/aasx-package-explorer/v16/.suo
2727
/.vs/slnx.sqlite
28-
/.vs/aasx-package-explorer/v17/.suo
29-
/src/WpfXamlTool/Properties/AssemblyInfo.cs
30-
/src/WpfMtpVisuViewer/Properties/AssemblyInfo.cs
31-
/src/WpfMtpControl/Properties/AssemblyInfo.cs
32-
/src/MsaglWpfControl/Properties/AssemblyInfo.cs
28+
/.vs/aasx-package-explorer/v17/.suo
29+
/src/WpfXamlTool/Properties/AssemblyInfo.cs
30+
/src/WpfMtpVisuViewer/Properties/AssemblyInfo.cs
31+
/src/WpfMtpControl/Properties/AssemblyInfo.cs
32+
/src/MsaglWpfControl/Properties/AssemblyInfo.cs
33+
/.vs/AASPE_Code/v17/.wsuo
34+
/.vs

‎CODE_OF_CONDUCT.md

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Community Code of Conduct
2+
3+
**Version 2.0
4+
January 1, 2023**
5+
6+
## Our Pledge
7+
8+
In the interest of fostering an open and welcoming environment, we as community members, contributors, Committers[^1], and Project Leads (collectively "Contributors") pledge to make participation in our projects and our community a harassment-free and inclusive experience for everyone.
9+
10+
This Community Code of Conduct ("Code") outlines our behavior expectations as members of our community in all Eclipse Foundation activities, both offline and online. It is not intended to govern scenarios or behaviors outside of the scope of Eclipse Foundation activities. Nor is it intended to replace or supersede the protections offered to all our community members under the law. Please follow both the spirit and letter of this Code and encourage other Contributors to follow these principles into our work. Failure to read or acknowledge this Code does not excuse a Contributor from compliance with the Code.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contribute to creating a positive and professional environment include:
15+
16+
- Using welcoming and inclusive language;
17+
- Actively encouraging all voices;
18+
- Helping others bring their perspectives and listening actively. If you find yourself dominating a discussion, it is especially important to encourage other voices to join in;
19+
- Being respectful of differing viewpoints and experiences;
20+
- Gracefully accepting constructive criticism;
21+
- Focusing on what is best for the community;
22+
- Showing empathy towards other community members;
23+
- Being direct but professional; and
24+
- Leading by example by holding yourself and others accountable
25+
26+
Examples of unacceptable behavior by Contributors include:
27+
28+
- The use of sexualized language or imagery;
29+
- Unwelcome sexual attention or advances;
30+
- Trolling, insulting/derogatory comments, and personal or political attacks;
31+
- Public or private harassment, repeated harassment;
32+
- Publishing others' private information, such as a physical or electronic address, without explicit permission;
33+
- Violent threats or language directed against another person;
34+
- Sexist, racist, or otherwise discriminatory jokes and language;
35+
- Posting sexually explicit or violent material;
36+
- Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history;
37+
- Personal insults, especially those using racist or sexist terms;
38+
- Excessive or unnecessary profanity;
39+
- Advocating for, or encouraging, any of the above behavior; and
40+
- Other conduct which could reasonably be considered inappropriate in a professional setting
41+
42+
## Our Responsibilities
43+
44+
With the support of the Eclipse Foundation employees, consultants, officers, and directors (collectively, the "Staff"), Committers, and Project Leads, the Eclipse Foundation Conduct Committee (the "Conduct Committee") is responsible for clarifying the standards of acceptable behavior. The Conduct Committee takes appropriate and fair corrective action in response to any instances of unacceptable behavior.
45+
46+
## Scope
47+
48+
This Code applies within all Project, Working Group, and Interest Group spaces and communication channels of the Eclipse Foundation (collectively, "Eclipse spaces"), within any Eclipse-organized event or meeting, and in public spaces when an individual is representing an Eclipse Foundation Project, Working Group, Interest Group, or their communities. Examples of representing a Project or community include posting via an official social media account, personal accounts, or acting as an appointed representative at an online or offline event. Representation of Projects, Working Groups, and Interest Groups may be further defined and clarified by Committers, Project Leads, or the Staff.
49+
50+
## Enforcement
51+
52+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Conduct Committee via conduct@eclipse-foundation.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Without the explicit consent of the reporter, the Conduct Committee is obligated to maintain confidentiality with regard to the reporter of an incident. The Conduct Committee is further obligated to ensure that the respondent is provided with sufficient information about the complaint to reply. If such details cannot be provided while maintaining confidentiality, the Conduct Committee will take the respondent‘s inability to provide a defense into account in its deliberations and decisions. Further details of enforcement guidelines may be posted separately.
53+
54+
Staff, Committers and Project Leads have the right to report, remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code, or to block temporarily or permanently any Contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. Any such actions will be reported to the Conduct Committee for transparency and record keeping.
55+
56+
Any Staff (including officers and directors of the Eclipse Foundation), Committers, Project Leads, or Conduct Committee members who are the subject of a complaint to the Conduct Committee will be recused from the process of resolving any such complaint.
57+
58+
## Responsibility
59+
60+
The responsibility for administering this Code rests with the Conduct Committee, with oversight by the Executive Director and the Board of Directors. For additional information on the Conduct Committee and its process, please write to <conduct@eclipse-foundation.org>.
61+
62+
## Investigation of Potential Code Violations
63+
64+
All conflict is not bad as a healthy debate may sometimes be necessary to push us to do our best. It is, however, unacceptable to be disrespectful or offensive, or violate this Code. If you see someone engaging in objectionable behavior violating this Code, we encourage you to address the behavior directly with those involved. If for some reason, you are unable to resolve the matter or feel uncomfortable doing so, or if the behavior is threatening or harassing, please report it following the procedure laid out below.
65+
66+
Reports should be directed to <conduct@eclipse-foundation.org>. It is the Conduct Committee’s role to receive and address reported violations of this Code and to ensure a fair and speedy resolution.
67+
68+
The Eclipse Foundation takes all reports of potential Code violations seriously and is committed to confidentiality and a full investigation of all allegations. The identity of the reporter will be omitted from the details of the report supplied to the accused. Contributors who are being investigated for a potential Code violation will have an opportunity to be heard prior to any final determination. Those found to have violated the Code can seek reconsideration of the violation and disciplinary action decisions. Every effort will be made to have all matters disposed of within 60 days of the receipt of the complaint.
69+
70+
## Actions
71+
Contributors who do not follow this Code in good faith may face temporary or permanent repercussions as determined by the Conduct Committee.
72+
73+
This Code does not address all conduct. It works in conjunction with our [Communication Channel Guidelines](https://www.eclipse.org/org/documents/communication-channel-guidelines/), [Social Media Guidelines](https://www.eclipse.org/org/documents/social_media_guidelines.php), [Bylaws](https://www.eclipse.org/org/documents/eclipse-foundation-be-bylaws-en.pdf), and [Internal Rules](https://www.eclipse.org/org/documents/ef-be-internal-rules.pdf) which set out additional protections for, and obligations of, all contributors. The Foundation has additional policies that provide further guidance on other matters.
74+
75+
It’s impossible to spell out every possible scenario that might be deemed a violation of this Code. Instead, we rely on one another’s good judgment to uphold a high standard of integrity within all Eclipse Spaces. Sometimes, identifying the right thing to do isn’t an easy call. In such a scenario, raise the issue as early as possible.
76+
77+
## No Retaliation
78+
79+
The Eclipse community relies upon and values the help of Contributors who identify potential problems that may need to be addressed within an Eclipse Space. Any retaliation against a Contributor who raises an issue honestly is a violation of this Code. That a Contributor has raised a concern honestly or participated in an investigation, cannot be the basis for any adverse action, including threats, harassment, or discrimination. If you work with someone who has raised a concern or provided information in an investigation, you should continue to treat the person with courtesy and respect. If you believe someone has retaliated against you, report the matter as described by this Code. Honest reporting does not mean that you have to be right when you raise a concern; you just have to believe that the information you are providing is accurate.
80+
81+
False reporting, especially when intended to retaliate or exclude, is itself a violation of this Code and will not be accepted or tolerated.
82+
83+
Everyone is encouraged to ask questions about this Code. Your feedback is welcome, and you will get a response within three business days. Write to <conduct@eclipse-foundation.org>.
84+
85+
## Amendments
86+
87+
The Eclipse Foundation Board of Directors may amend this Code from time to time and may vary the procedures it sets out where appropriate in a particular case.
88+
89+
### Attribution
90+
91+
This Code was inspired by the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct/).
92+
93+
[^1]: Capitalized terms used herein without definition shall have the meanings assigned to them in the Bylaws.

‎CONTRIBUTING.md

+183
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# Contributing
2+
3+
Welcome to the Eclipse AASX Package Explorer repository.
4+
5+
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.
6+
7+
The [Development guildelines](#development-guidelines) section includes general guidelines as well as additional quirks specific to Eclipse Foundation projects, so it is definitely worth a read as well.
8+
9+
## Joining Development
10+
11+
### Eclipse Foundation incubated project
12+
13+
AASX Package Explorer is an Eclipse Foundation incubated project and therefore needs to adhere to Eclipse Foundation rules.
14+
This introduces a slight overhead for every contributor, at least at the very beginning, but it's worth it!
15+
16+
Follow these steps to become a Contributor in Eclipse AASX Package Explorer (and any other project under the Eclipse Foundation umbrella):
17+
18+
1. Create an Eclipse Foundation Account at https://accounts.eclipse.org/
19+
20+
1. Log in to your Eclipse account and digitally sign the [Eclipse Contributor Agreement](https://www.eclipse.org/projects/handbook/#contributing-eca)
21+
22+
1. Make sure to add your github name (`Edit my account` > `Social Media Links` > `GitHub Username`)
23+
24+
1. Clone or fork the repository and create an initial commit
25+
- if you have preexisting work that you'd like to include, see [Migrating Development](#migrating-development)
26+
- ensure that the author credentials on the commit record match the email address and/or GitHub username associated with the Eclipse Foundation Account
27+
28+
1. Create a pull request and work with the project team to merge the contribution
29+
- your request will need to be reviewed and approved by an Eclipse Contributor (GitHub Maintainer role)
30+
31+
1. Happily develop ever after!
32+
- 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)
33+
34+
For more details see ["Contributing" in Eclipse Foundation Handbook](https://www.eclipse.org/projects/handbook/#contributing-contributors).
35+
36+
### Migrating development
37+
38+
If you are moving over from admin-shell-io, you can simply clone the repository anew and work on a clean slate.
39+
40+
However, if you have local changes that you want to take over, you will need to update the remotes with the new repository url.
41+
42+
Here is how to
43+
switch from `https://github.com/admin-shell-io/aasx-package-explorer`
44+
to `https://github.com/eclipse-aaspe/aaspe`
45+
from the command line:
46+
47+
1. First, we suggest to `fetch`/`pull` and `commit` all local changes.
48+
49+
2. We can check the current remote anytime with `git remote`:
50+
51+
```
52+
D:\aasx-package-explorer> git remote -vvv
53+
origin https://github.com/admin-shell-io/aasx-package-explorer (fetch)
54+
origin https://github.com/admin-shell-io/aasx-package-explorer (push)
55+
```
56+
57+
2. Remove the old remote called "origin" with `git remote rm <remote-name>`
58+
59+
```
60+
D:\aasx-package-explorer> git remote rm origin
61+
```
62+
63+
3. Add the new repository url as a remote, also called "origin", with `git remote add <new-remote-name> <new-remote-url>`
64+
65+
```
66+
D:\aasx-package-explorer> git remote add origin https://github.com/eclipse-aaspe/aaspe
67+
D:\aasx-package-explorer> git remote -vvv
68+
origin https://github.com/eclipse-aaspe/aaspe (fetch)
69+
origin https://github.com/eclipse-aaspe/aaspe (push)
70+
```
71+
72+
4. The git links have been successfully updated. Now you can push a local branch with your work to the new repository using `git push -u <remote-name> <new-remote-branch-name>`
73+
74+
```
75+
D:\aasx-package-explorer> git push -u origin mf/branch
76+
```
77+
78+
> [!note]
79+
> Please note, it would also work to leave the "origin" untouched and just create a second remote, for example called "aaspe".
80+
> In this case, you need to specify which remote you want to pull from/push to.
81+
> It is easier to stick to the usual default remote name "origin".
82+
83+
## Development guidelines
84+
85+
tbd:
86+
87+
- disabled projects
88+
- dependencies
89+
- pipelining/admin/configuration
90+
- releases
91+
92+
> [!tip]
93+
> Additional information can be found at the [devdocs](https://admin-shell-io.github.io/aasx-package-explorer/devdoc/) (work-in-progress)
94+
95+
### How to contribute
96+
97+
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).
98+
99+
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/.
100+
101+
For further information about the Asset Administration Shell, see the publication Details of the Asset Administration Shell by Plattform Industrie 4.0.
102+
103+
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/
104+
105+
### Terms of Use
106+
107+
This Eclipse Foundation open project is governed by the Eclipse Foundation
108+
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.
109+
110+
### Communication
111+
112+
Communication between contributors takes place predominantly through project issues and repository mailing list: TBD
113+
114+
### Repositories
115+
116+
Source code is publically available in the https://github.com/eclipse-aaspe/aaspe repository.
117+
118+
### ECA
119+
120+
Contributors are required to electronically sign the Eclipse Contributor Agreement (https://www.eclipse.org/legal/ECA.php) to contribute to Eclipse AASX Package Explorer™.
121+
122+
Commits that are provided by non-committers must contain a Signed-off-by field in
123+
the footer indicating that the author is aware of the terms by which the
124+
contribution has been provided to the project. The non-committer must
125+
additionally have an Eclipse Foundation account and must have a signed Eclipse
126+
Contributor Agreement (ECA) on file.
127+
128+
129+
## Appendix: Eclipse sources - useful links
130+
131+
##### Development process
132+
133+
https://www.eclipse.org/projects/dev_process/
134+
135+
Overview/flowchart of the whole process
136+
https://www.eclipse.org/projects/dev_process/#6_Development_Process
137+
138+
##### Project handbook
139+
140+
https://www.eclipse.org/projects/handbook/
141+
142+
Starting an OS project with Eclipse Foundation
143+
https://www.eclipse.org/projects/handbook/#starting
144+
145+
User roles (User/Committer/Project Lead/Project Management Committee)
146+
https://www.eclipse.org/projects/handbook/#roles
147+
148+
Intellectual property
149+
https://www.eclipse.org/projects/handbook/#ip
150+
151+
Releases
152+
https://www.eclipse.org/projects/handbook/#release
153+
154+
##### Development resources
155+
156+
https://wiki.eclipse.org/Development_Resources
157+
158+
Getting started
159+
https://wiki.eclipse.org/Development_Resources#Projects:_Getting_Started
160+
161+
Incubation phase
162+
https://wiki.eclipse.org/Development_Resources/HOWTO/Incubation_Phase
163+
164+
##### Eclipsepedia
165+
166+
https://wiki.eclipse.org/Main_Page
167+
168+
FAQs
169+
https://wiki.eclipse.org/The_Official_Eclipse_FAQs
170+
171+
IP stuff
172+
https://wiki.eclipse.org/IP_Stuff
173+
174+
##### Misc
175+
176+
Legal: committer “due diligence” guidelines
177+
https://www.eclipse.org/legal/committerguidelines.php
178+
179+
Project management infrastructure
180+
https://wiki.eclipse.org/Project_Management_Infrastructure
181+
182+
Forges (community of communities)
183+
https://wiki.eclipse.org/Forges

0 commit comments

Comments
 (0)