Thank you for investing your time in contributing to our projects!
Read our Code of Conduct to keep our community approachable and respectable.
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 do not report vulnerabilities and security incidents as GitHub issues. Please contact us by sending an E-Mail to Open Source Program Office or report them using the contact form at https://fachportal.gematik.de/kontaktformular.
To get an overview of the project, read the README.
If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.
Scan through our existing issues to find one that interests you. If you find an issue to work on, you are welcome to open a PR with a fix.
gematik projects follow the google style guide conventions. Please follow them when working on your contributions.
When adding new terraform resources, please make sure to follow the existing naming conventions of the other resources. Resource names have to be defined in naming convention of snake-case and files are formatted well (will be enforced).
When adding new terraform modules, please make sure to follow the existing structure of the other modules. each module has to be defined in modules folder with its own subfolder. the module has to be tested and documented by adding a README.md file in the module folder (created automatically by terraform-docs).
When adding new features, please make sure to add a feature flag to be able to disable the feature if necessary. Feature flags should be disabled by default, names starting with FEATURE_FLAG (will be enforced) and letters are uppercase in naming convention of snake-case.
When adding new configuration options, please make sure that the name starts CONFIG and letters are uppercase in naming convention of snake-case. the value has tobe defined as string.
When adding new helm charts, please make sure to follow the existing structure of the other helm charts. each helm chart has to be defined a new terraform file in naming convention of chart-.tf. if multiple instances of the same helm chart are necessary, they will be defined in the same terraform file with different release names.
Database names, table names, column names, user names, role names and similar has to be defined in naming convention of snake-case.
Commit the changes once you are happy with them.
- 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 if you are solving one.
- Update the README.md, the documentation and the ReleaseNotes.md with all details to document the changes made by this PR.
- Increase the version numbers in any necessary files and the readme to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
- 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 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.
- 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.
Congratulations 🎉🎉 The gematik team thanks you ✨.
Once your PR is merged, your contributions will be publicly visible on the gematik github page.