readme-update
Installation
SKILL.md
README-oppdatering for Nav-repoer
Bruk denne skillen når README skal opprettes eller oppdateres i et Nav-repo. README-en skal speile det repoet faktisk gjør i dag — ikke fylle ut en generisk mal.
Steg 1: Les repoet først
Les faktiske kilder før du skriver én linje README:
- Eksisterende README — bevar manuelt innhold, lenker, Slack-kanaler og stabile utviklingsdetaljer som lokal URL eller peker til discovery-kommandoer som fortsatt er riktige.
- Stack og bygg — les
package.json,pnpm-workspace.yaml,turbo.json,build.gradle.kts,pom.xml,Dockerfileeller tilsvarende. - NAIS-manifest — les
.nais/for miljøer,ingresses, databaser, Kafka,accessPolicy, TokenX/Azure/ID-porten og eventuelle eksterne avhengigheter. - Kode — les
src/,app/,server/,api/eller tilsvarende for endepunkter, konsumenter, produsenter, databaser og frontend/backend-koblinger. - CI/CD — les
.github/workflows/for workflow-navn som kan brukes i badge eller utviklingsseksjon. - Docs — les
docs/,README-filer i undermapper og arkitektur-notater, og lenk heller enn å duplisere lange forklaringer.
Avklar minst dette før du skriver: