Sådan bidrager du til dokumentationen
Tak fordi du vil bidrage til OS2-sekretariatets håndbog!
Formålet er at holde vores fælles vejledninger opdaterede, tydelige og nyttige for både nye og erfarne medarbejdere.
Vi arbejder efter principperne for Docs As Code og i det åbne Markdown-format, så alle kan deltage på lige vilkår.
Vores dokumentation følger desuden den åbne Standard for Public Code for at sikre kvalitet, gennemsigtighed og genbrug i det offentlige.
Principper for samarbejde
Vi arbejder åbent og tillidsfuldt — på samme måde som vi forventer det i OS2-fællesskabet:
- Vær konstruktiv og respektfuld i diskussioner.
- Del viden, ikke kun rettelser. Forklar gerne hvorfor du foreslår en ændring.
- Skriv klart og forståeligt. Vi skriver for mennesker først og systemer bagefter.
- Brug issues til dialog, ikke kun fejlrapporter.
- Alle ændringer sker gennem pull requests, så der altid er gennemsyn og fælles ejerskab.
Kom hurtigt i gang
- Find eller opret et issue
- Kig først, om der allerede findes et issue om det emne, du vil bidrage til.
- Hvis ikke, opret et nyt issue og beskriv kort:
- Hvad du foreslår at ændre eller tilføje
- Hvorfor det er relevant
- Evt. forslag til løsning eller forbedring
- Deltag i dialogen
- Alle kan kommentere på et issue. Brug kommentarsporet til at kvalificere løsningen, dele eksempler og stille spørgsmål.
- Hvis du har særlige kompetencer inden for et område, kan du selv foreslå dig som assignee til et issue.
- Arbejd i et branch
- Når du begynder at skrive eller redigere, så opret et nyt branch fra
main. - Lav dine ændringer i Markdown (.md-filer) og commit tydeligt.
- Send en pull request (PR), når du er klar, og henvis gerne til det issue, PR’en løser.
- Når du begynder at skrive eller redigere, så opret et nyt branch fra
- Få feedback og merge
- En maintainer eller kollega gennemgår din PR.
- Når ændringen er godkendt, merges den til
main, og dokumentationen bliver automatisk opdateret på websitet.
Skrivetips
- Brug korte afsnit og præcise overskrifter (
##,###) - Brug punktopstillinger og links frem for lange tekstblokke
- Skriv i nutid og aktiv form
- Undgå interne forkortelser uden forklaring
- Henvis altid til kilder, skabeloner eller relevante filer i repositoriet
Lær mere
- Markdown guide – grundlæggende syntaks og eksempler
- Standard for Public Code – ramme for kvalitet og transparens
- Just the Docs – hvordan dokumentationen vises som website
Spørgsmål eller forslag?
Har du spørgsmål, idéer eller forbedringer, så opret et issue eller tag fat i sekretariatet på os2@os2.eu
Tak fordi du hjælper med at gøre OS2’s dokumentation bedre — sammen bygger vi et mere åbent og robust fællesskab.