Skip to content

Contribution Guidelines (CONTRIBUTING.md)

Warum?

Wir wollen unsere Repos zugänglicher für (neue) interne und externe Personen machen, die zum Projekt beitragen wollen. Hierzu sollen Contribution Guidelines etabliert werden. Neue Leute sollen sich im Projekt direkt wohl fühlen und herzlich eingeladen werden, sich zu beteiligen.

GitHub beschreibt Contribution Guidelines wie folgt:

For the repository owner, contribution guidelines are a way to communicate how people should contribute.

For contributors, the guidelines help them verify that they're submitting well-formed pull requests and opening useful issues.

source: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Relevante Links und Bemerkungen

Einige Vorlagen für gute Contribution Guidelines:

Zu klären

  1. Brauchen wir zusätzlich zu den CONTRIBUTING.md-Dateien auch eine Unterseite in der [öffentlichen Dokumentation], die Grundsätze für Beitragende erklärt? (Falls ja, sollte diese Seite in allen CONTRIBUTING.md-Dateien verlinkt sein)
  • ggf. etwas vergleichbares zum New contributor guide in den GitHub docs?
  • Beschreibung, wie Bugs gemeldet werden können (vgl. rails)
  • Eine Erklärung, wie Commit Messages aussehen sollten (vgl. opengovernment
  • Coding conventions? / .editorconfig
  • weitere Inhalte aus unserer Teamvereinbarung?
  1. Englisch oder Deutsch?
  2. Build Instructions in der CONTRIBUTING.md oder in der README.md?

Akzeptanzkriterien

  1. In allen öffentlichen Repositories existiert eine CONTRIBUTING.md-Datei.
  2. Die Datei enthält eine kurze Einleitung, in der Externe zu Beträgen motiviert werden und erklärt wird, wie Externe beitragen können.
  3. (ggf.) Die Datei verweist auf die Unterseite in der [öffentlichen Dokumentation], die Grundsätze für Beitragende erklärt.
  4. In der Contributing.md finden Build Instructions / "Prerequisites". In der README.md wird auf diese Build Instructions verweisen.
  5. In der Contributing.md findet sich ein Abschnitt zur Ausführung von Tests (Testing).
  6. In der Contributing.md findet sich ein Abschnitt zur Dokumentation.
  7. In der Contributing.md findet sich ein Abschnitt zum Prozess, wie/wo neue Pull-Requests erstellt werden können und was es dabei zu beachten gilt.
  8. In der Contributing.md finden sich nach Bedarf weitere Infos, die einen Einstieg für neue Leute so einfach wie möglich machen.
  9. Die Contributing.md ist nicht zu lang und übersichtlich strukturiert.

Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)

Edited by Marco Holz