Skip to main content

Versjon

Oppdater versjon​

Det er viktig å holde en riktig og oppdatert versjonslogg, slik at det skal bli enklere for brukere av KVIB å kunne se endringer som har blitt gjort mellom hver versjon av biblioteket. Seksjonen øverst i dokumentet viser en oversikt over kommendene endringer. I versjonsloggen skal den nyeste versjonen stå øverst sammen med utgivelsesdato.

Versjonering følger konvensjoner fra Semantic Versioning. Hovedsakelig inkrementerer patch-versjon ved bakover kompatibel bug-fix, minor-versjon ved ny bakover kompatibel funksjonalitet og major-versjon ved funksjonalitet som ikke er bakover kompatibel.

For hver endring som gjøres, skal den nye versjonen dokumenteres:

  • Legg til ny .md fil under kvib/blog, med filnavn: YYYY-MM-DD-version[major.minor.patch].md (formatet gjør at dato generes automatisk)

  • Legg til følgende øverst i filen:

blog/YYYY-MM-DD-version[major.minor.patch].md
---
title: Versjon [major.minor.patch]
description: Kort beskrivelse av .md filen
tags: [tag, tag]
---

  • Skriv en beskrivelse av endringer som er gjort i versjonen ved å bruke følgende titler (sett som <h2>):

    • Added: nye funksjoner som er lagt til

    • Changed: endringer som er gjort

    • Deprecated: funksjoner som snart skal fjernes.

    • Removed: funskjoner som er fjernet.

    • Fixed: bugs som er fikset.

    • Security: dersom det er sårbarheter i koden.