Skip to content

Commit f1f742d

Browse files
authored
Merge pull request #10 from gematik/ospo_updates_opb5
Facilitate ease of Contribution and Understanding of the Project
2 parents 6edfc67 + aed7d55 commit f1f742d

File tree

5 files changed

+138
-56
lines changed

5 files changed

+138
-56
lines changed

.gitignore

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +0,0 @@
1-
publish.jenkinsfile
2-
release.jenkinsfile
3-
validation.jenkinsfile
4-
5-
publish.jenkinsfile
6-
release.jenkinsfile
7-
validation.jenkinsfile
8-
9-
publish.jenkinsfile
10-
release.jenkinsfile
11-
validation.jenkinsfile
12-
13-
publish.jenkinsfile
14-
release.jenkinsfile
15-
validation.jenkinsfile
16-
17-
publish.jenkinsfile
18-
release.jenkinsfile
19-
validation.jenkinsfile
20-
21-
publish.jenkinsfile
22-
release.jenkinsfile
23-
validation.jenkinsfile
24-
25-
publish.jenkinsfile
26-
release.jenkinsfile
27-
validation.jenkinsfile
28-
29-
publish.jenkinsfile
30-
release.jenkinsfile
31-
validation.jenkinsfile
32-
33-
publish.jenkinsfile
34-
release.jenkinsfile
35-
validation.jenkinsfile
36-
jenkinsfiles
37-
38-
39-
publish.jenkinsfile
40-
release.jenkinsfile
41-
validation.jenkinsfile
42-
jenkinsfiles
43-

CODE_OF_CONDUCT.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
## Code of Conduct
2+
3+
### Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
### Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Calls for violence, vilification and advertising
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
### Our Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or
42+
reject comments, commits, code, wiki edits, issues, and other contributions
43+
that are not aligned to this Code of Conduct, or to ban temporarily or
44+
permanently any contributor for other behaviors that they deem inappropriate,
45+
threatening, offensive, or harmful.
46+
47+
### Scope
48+
49+
This Code of Conduct applies both within project spaces and in public spaces
50+
when an individual is representing the project or its community. Examples of
51+
representing a project or community include using an official project e-mail
52+
address, posting via an official social media account, or acting as an appointed
53+
representative at an online or offline event. Representation of a project may be
54+
further defined and clarified by project maintainers.
55+
56+
### Enforcement
57+
58+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59+
reported by contacting the project team at OSPO@gematik.de. All
60+
complaints will be reviewed and investigated and will result in a response that
61+
is deemed necessary and appropriate to the circumstances. The project team is
62+
obligated to maintain confidentiality with regard to the reporter of an incident.
63+
Further details of specific enforcement policies may be posted separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
### Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
72+
available at [http://contributor-covenant.org/version/1/4][version]
73+
74+
[homepage]: http://contributor-covenant.org
75+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Welcome to the gematik contributing guide <!-- omit in toc -->
2+
3+
Thank you for investing your time in contributing to our projects!
4+
5+
In this guide you will get an overview how you can contribute to our projects by opening an issue, creating, reviewing and merging a pull request.
6+
7+
Please also read our [Code of Conduct](./CODE_OF_CONDUCT.md) to understand how to keep our community approachable and respectable.
8+
9+
Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.
10+
11+
## Reporting a security vulnerability
12+
13+
Please do not report vulnerabilities and security incidents as GitHub issues. Please contact us by sending an E-Mail to TODO or report them using the contact form at https://fachportal.gematik.de/kontaktformular.
14+
15+
## New contributor guide
16+
17+
To get an overview of the project, read the [README](./README.md).
18+
19+
## Getting started
20+
21+
### Commit your update
22+
23+
Commit the changes once you are happy with them.
24+
25+
### Pull Request Process
26+
27+
- When you're finished with the changes, create a pull request, also known as a PR.
28+
- Fill the pull request template so that we can review your PR. This template helps reviewers to understand your changes as well as the purpose of your pull request.
29+
- Don't forget to [link the PR to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
30+
- Update the [README.md](./README.md), the documentation and the [ReleaseRotes.md](./ReleaseNotes.md) with all details to document the changes made by this PR.
31+
- Increase the version numbers in any necessary files and the [readme](./README.md) to the new version that this
32+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
33+
- Once you submit your PR, a project team member will review your proposal. We may ask questions or request additional information.
34+
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request)
35+
or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
36+
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
37+
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you
38+
do not have permission to do that, you may request the second reviewer to merge it for you.
39+
40+
### Your PR is merged!
41+
42+
Congratulations :tada::tada: The gematik team thanks you :sparkles:.
43+
44+
Once your PR is merged, your contributions will be publicly visible on the [gematik github page](https://github.com/gematik/).

Readme.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1-
## Allgemeines
2-
Dieses Repository enthält Schnittstellendefinitionen im XSD- und WSDL-Format für die unten gelisteten Produkttypversionen.
3-
## Struktur
1+
<img width="200" height="37" src="images/Gematik_Logo_Flag.png"/> <br/>
42

5-
| Verzeichnis | Unterverzeichnis |Zuordnung
3+
# Telematik API Specification
4+
5+
## About the Project
6+
This repository contains interface definitions in XSD as well as in WSDL format.
7+
8+
## Folder Structure
9+
10+
| Folder | Subfolder |Content (German)
611
|--- |--- |---
7-
|cm\ | | __Kartenmanagement__
8-
|conn\ | | __Konnektorschnittstellen__
9-
| |amtss\ | AMTS
10-
| |nfds\ | NFDM
11-
| |phrs\ | ePA
12-
| |tbauth\ | TBAuth
13-
| |vsds\ | VSDM
12+
|cm\ | |__Kartenmanagement__
13+
|conn\ | |__Konnektorschnittstellen__
14+
| |amtss\ |AMTS
15+
| |nfds\ |NFDM
16+
| |phrs\ |ePA
17+
| |tbauth\ |TBAuth
18+
| |vsds\ |VSDM
1419
|consumer\ | | __Basis-/KTR-Consumer__
1520
|ext\ | |Schemadateien internationaler Standardisierungsgremien
1621
|ext\\\*hardened* | |Gehärtete Schemadateien, Bezeichner _XSD_HARDENED_
@@ -25,5 +30,6 @@ Dieses Repository enthält Schnittstellendefinitionen im XSD- und WSDL-Format f
2530
|tel\ | |__Architektur und übergreifende Dokumente__
2631
|vpnzugd\ | |__VPN-Zugangsdienst__
2732
|vzd\ | |__Verzeichnisdienst__
28-
### Hinweis zum Umzug der Schnittstelle des Aktensystems
29-
> Die Schnittstellen des ePA-Aktensystems wurden aus diesem Repository nach https://github.com/gematik/api-ePA.git verlagert und werden hier nicht weiter gepflegt.
33+
### Hint WRT Moving the Interface of the 'ePA-Aktensystem'
34+
35+
> The interface of the 'ePA-Aktensystem' has been moved out of this repository over to https://github.com/gematik/api-ePA.git and thus will not be maintained any further here.

images/Gematik_Logo_Flag.png

36.1 KB
Loading

0 commit comments

Comments
 (0)