Merge pull request #9 from gematik/ospo_updates

Facilitate ease of Contribution and Understanding of the Project

CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Calls for violence, vilification and advertising
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at OSPO@gematik.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Welcome to the gematik contributing guide <!-- omit in toc -->
+
+Thank you for investing your time in contributing to our projects!
+
+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.
+
+Please also read our [Code of Conduct](./CODE_OF_CONDUCT.md) to understand how to keep our community approachable and respectable.
+
+Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.
+
+## Reporting a security vulnerability
+
+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.
+
+## New contributor guide
+
+To get an overview of the project, read the [README](./README.md).
+
+## Getting started
+
+### Commit your update
+
+Commit the changes once you are happy with them.
+
+### Pull Request Process
+
+- When you're finished with the changes, create a pull request, also known as a PR.
+- 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.
+- 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.
+- 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.
+- Increase the version numbers in any necessary files and the [readme](./README.md) to the new version that this
+  Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+- Once you submit your PR, a project team member will review your proposal. We may ask questions or request additional information.
+- 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)
+  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.
+- 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).
+- You may merge the Pull Request in once you have the sign-off of two other developers, or if you
+  do not have permission to do that, you may request the second reviewer to merge it for you.
+
+### Your PR is merged!
+
+Congratulations :tada::tada: The gematik team thanks you :sparkles:.
+
+Once your PR is merged, your contributions will be publicly visible on the [gematik github page](https://github.com/gematik/).

Readme.md

@@ -1,16 +1,21 @@
- ## Allgemeines
-Dieses Repository enthält Schnittstellendefinitionen im XSD- und WSDL-Format für die unten gelisteten Produkttypversionen.
- ## Struktur
+<img width="200" height="37" src="images/Gematik_Logo_Flag.png"/> <br/>
 
-| Verzeichnis       | Unterverzeichnis  |Zuordnung 
+# Telematik API Specification
+
+ ## About the Project
+This repository contains interface definitions in XSD as well as in WSDL format.
+
+ ## Folder Structure
+
+| Folder            | Subfolder         |Content (German)
 |---                |---                |---
-|cm\                |                   | __Kartenmanagement__
-|conn\              |                   | __Konnektorschnittstellen__
-|                   |amtss\             | AMTS
-|                   |nfds\              | NFDM
-|                   |phrs\              | ePA
-|                   |tbauth\            | TBAuth
-|                   |vsds\              | VSDM
+|cm\                |                   |__Kartenmanagement__
+|conn\              |                   |__Konnektorschnittstellen__
+|                   |amtss\             |AMTS
+|                   |nfds\              |NFDM
+|                   |phrs\              |ePA
+|                   |tbauth\            |TBAuth
+|                   |vsds\              |VSDM
 |consumer\          |                   | __Basis-/KTR-Consumer__
 |ext\               |                   |Schemadateien internationaler Standardisierungsgremien
 |ext\\\*hardened*   |                   |Gehärtete Schemadateien, Bezeichner _XSD_HARDENED_
@@ -25,5 +30,6 @@ Dieses Repository enthält Schnittstellendefinitionen im XSD- und WSDL-Format f
 |tel\               |                   |__Architektur und übergreifende Dokumente__
 |vpnzugd\           |                   |__VPN-Zugangsdienst__
 |vzd\               |                   |__Verzeichnisdienst__
-### Hinweis zum Umzug der Schnittstelle des Aktensystems
-   > Die Schnittstellen des ePA-Aktensystems wurden aus diesem Repository nach https://github.com/gematik/api-ePA.git verlagert und werden hier nicht weiter gepflegt.
+### Hint WRT Moving the Interface of the 'ePA-Aktensystem'
+
+   > 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.