Trivadis Good Practice Template
Welcome to the Good Practice Template. This repository is a template for various Good Practice Guidelines. It contains the necessary structures, base documents and CI pipelines for the automatic creation of these documents. When creating a new Good Practice Guidelines, this repository can be used directly as a template. Corresponding links and references in the Markdown files have to be adapted to the new repository afterwards. In general, these are just the links in this README.md.
Downloads and Latest Builds
The official release documents are always attached to the releases. See also the release page of this repository.
- Word document en, de
- PDF document en, de
- Source code
Nightly Builds respectively builds on commit are attached as artefacts to the GitHub workflow, see Generated Documents.
Files and Folders
- de German documentation files.
- en English documentation files.
- images Images and logo files.
- templates Various pandoc templates.
- AUTHOR_GUIDE General author's guide to Good Practices. This has to be adapted to the corresponding guideline.
- CHANGELOG Change log for the Good Practices.
- CODE_OF_CONDUCT Code of conduct for the interaction and cooperation within the framework of this project.
- CONTRIBUTING Guide how to contribute to this project.
Releases and Versions
You find all official releases and release information on the GitHub release page here. As well documented in the CHANGELOG.
The versioning and release tags follow the semantic versioning. A version number is specified by MAJOR.MINOR.PATCH, increase the:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards compatible manner, and
- PATCH version when you make backwards compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
Issues and Enhancements
Please file your bug reports, enhancement requests, questions and other support requests within Github's issue tracker.
How to Contribute
It is highly recommended to take into account CONTRIBUTING and AUTHOR_GUIDE when contributing to this Good Practice. However contributing covers the following steps.
- Describe your idea by submitting an issue
- Fork this respository
- Create a branch, commit and publish your changes and enhancements
- Create a pull request
License
Trivadis/good-practice-template is licensed under the Apache License 2.0. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.