Contributing.md

Wie kann ich mithelfen?

Cool, dass Du hier bist 🎉! Hier einige Hinweise:

Ich möchte eine weitere API des Bundes dokumentieren!

Bitte lege im Sofortmaßnahmen-Repository ein Issue an, damit wir das diskutieren können. Dann werden wir Dir ein Repo in der Organisation und entsprechende Domains aufsetzen. Du kannst uns auch anonym (z.B. via [email protected]) Dokumentation zukommen lassen, die wir dann veröffentlichen.

Ich möchte an einer bestehenden Doku weiterarbeiten!

Super, gerne, einfach PR/Issue aufmachen.

Etwas ist kaputt, ich kann/will es aber nicht lösen.

Bitte lege ein Issue im möglichst passenden Projekt an. Wir schauen dann, was wir tun können.

Ist das eine Seite der Bundesrepublik Deutschland?

Noch nicht 😉.

Soll/darf man auch „öffentliche“ APIs dokumentieren, die nur nach Registrierung (ggf. erst nach manueller Freischaltung) verfügbar sind?

Ja, wir würden gerne so viel wie möglich dokumentieren.

Darf ich hier auch die API eines Bundeslandes oder einer Kommune dokumentieren?

Ja, bitte, es gibt ja keinen anderen Ort dafür. (Vielleicht müssen wir das zukünftig anders aufteilen …)