Brug en sammenhængende stil

Krav

• Bidrag SKAL overholde en kodnings- eller skrivestileguide, enten din egen eller en eksisterende, der er annonceret i eller som del af kodebasen.
• Bidrag BØR bestå automatiserede test på stil.
• Din kodebase BØR inkludere inline kommenterer eller dokumentation for atypiske sektioner.
• Du MÅ inkludere sektioner i din stilguide på forståeligt engelsk.

Hvorfor er dette vigtigt

• Muliggør bidragsydere i forskellige miljøer at arbejde sammen på et samlet projekt.
• Et samlet ordforråd reducerer friktion i kommunikation mellem bidragsydere.

Hvad dette ikke gør

• Hjælper bidragsydere med at skrive godt eller forklare effektivt, hvad de gør.

Hvordan tester man

• Inspicer hvorvidt bidrag overholder stilguiden, der er specificeret i dokumentationen.

Politiske beslutningstagere: hvad skal du gøre

• Skab, følg og løbende forbedr på en stilguide for politik og dokumentation samt at dokumentere dette i kodebasen, f.eks. i CONTRIBUTING eller README.

Ledelse: hvad skal du gøre

• Inkluder skriftligt sprog, kilde, test og politiske standarder i din organisations definition af kvalitet.

Udviklere og designere: hvad skal du gøre

• Skab, følg og løbende forbedr på en stilguide for kilde, tests og dokumentation samt dokumenter dette i kodebasen, f.eks. i CONTRIBUTING eller README.
• Brug en linter (værktøj til analyse af statisk kode).
• Tilføj linter konfigurationer til kodebasen.

Yderligere læsning

• List of linters af Hugo Martins.
• Programming style på Wikipedia.