A collection of templates we use to keep the quality consistent over the various projects we maintain.

We want to establish a consistent structure of the readme in our projects.

There are several projects that provide a readme template out there, for example https://www.makeareadme.com/ with a general suggestion for open source projects or the Standard Readme Style Specification especially for code modules. They differ only in details on the suggested sections. A good resource on writing great READMEs is also Art of README.

Our template is heavily based on these two templates.

The first project using this template is gvm-tools, which can be used as an example.

The ISSUE_TEMPLATE.md is shown to the user when they create a new issue on GitHub. We want to ensure that users provide the necessary information and to redirect support questions to our community forum.

The .pylintrc is the configuration for Pylint which is used to test the code quality of our python projects.

The pyproject.toml template provides a consistent specification of the minimum build system requirements for Python projects. The file format is specified in PEP518.

The template contains configuration options for the autohooks framework and for the black code formatter. Together, this configuration makes sure that all commits are properly formatted in a consistent style.

Note that both autohooks and black need to be present in the development environment for the configuration to be applied.

Copyright (C) 2018 Greenbone Networks GmbH

Licensed under the Creative Commons Attribution Share Alike 4.0 International license.