Dokumentera kodbasens mognad

Att tydligt signalera en kodbas’ mognad hjälper andra att avgöra om de ska använda och bidra till den. En kodbasversions mognad innefattar 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 RELEASE_NOTES-filen.
• Metoden för att tilldela versionsidentifierare BÖR vara dokumenterad.
• Att använda semantisk versionering är VALFRITT.

Hur du testar

• 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: vad ni behöver göra

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

Chefer: vad ni behöver göra

• 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: vad ni behöver göra

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

Vidare läsning

• Semantic Versioning Specification som används av många kodbaser för att märka versioner.
• Software release life cycle
• The Development Status key i publiccode.yml-standarden.
• Service Design and Delivery Process av Australian Digital Transformation Agency.
• Service Manual on Agile Delivery av UK Government Digital Service.