Community Translations of the Standard for Public Code

Contents

  1. Krav
  2. Test
  3. Offentliga beslutsfattare behöver:
  4. Chefer behöver:
  5. Utvecklare och formgivare behöver:
  6. Vidare läsning

Contribute on GitHub

Dokumentera kodbasens mognad

Att tydligt beskriva kodbasens mognad hjälper andra att avgöra om de ska använda och bidra till den. Mognaden hos en kodbasversion omfattar också mognaden hos dess beroenden. Att förstå hur en kodbas har utvecklats är nyckeln till att förstå kodbasen och hur man bidrar till den.

Krav

  • Kodbasen MÅSTE vara versionshanterad.
  • Kodbasen MÅSTE tydligt dokumentera huruvida det finns versioner av kodbasen som är redo att användas.
  • Kodbasversioner som är redo att användas MÅSTE bara bero på versioner av andra kodbaser som också är redo att användas.
  • Kodbasen BÖR innehålla en sammanfattning av ändringar från version till version, till exempel i CHANGELOG-filen.
  • Metoden för att tilldela versionsidentifierare BÖR vara dokumenterad.
  • Det är VALFRITT att använda semantisk versionering.

Test

  • Bekräfta att kodbasen har en dokumenterad strategi för versionering.
  • Bekräfta att det är uppenbart för beslutsfattare, chefer, utvecklare och formgivare huruvida kodbasen har versioner som är redo att användas.
  • Bekräfta att versioner av kodbasen som är redo att användas inte beror på versioner av andra kodbaser som inte är redo att användas.
  • Kontrollera att kodbasens versioneringsschema är dokumenterat och följs.
  • Kontrollera att det finns en sammanfattning av ändringar.

Offentliga beslutsfattare behöver:

  • Förstå att all källkod som utvecklas behöver testas och förbättras innan den kan tas i bruk när ni utvecklar regelverk.
  • Överväga att versionera regelverksändringar, särskilt när de leder till nya versioner av källkoden.

Chefer behöver:

  • Se till att tjänster bara förlitar sig på kodbasversioner med lika eller högre mognad än tjänsten. Använd till exempel inte en betaversion av en kodbas i en produktionstjänst.

Utvecklare och formgivare behöver:

  • Se till att kodbasens versioneringsmetod följs vid alla utgåvor.

Vidare läsning