Optimaliser GitHub Copilot for ditt prosjekt 🚀

Optimaliser GitHub Copilot for ditt prosjekt 🚀

By Anders Olsen Sandvik on

Note: Denne artikkelen er basert pÄ en melding jeg delte internt pÄ Slack om hvordan man kan optimalisere GitHub Copilot for sitt prosjekt.

Hei! 👋 Mange av oss bruker GitHub Copilot i hverdagen, men visste du at du kan gjþre KI-assistenten mye smartere for akkurat ditt prosjekt?

Hva er .github/copilot-instructions.md?

Dette er en fil du kan legge til i prosjektet ditt som gir Copilot ekstra kontekst. Alt du skriver her blir sendt med pÄ alle spÞrsmÄlene du stiller, og utvider konteksten KI-en jobber med.

Praktiske eksempler

Kodestil og konvensjoner:

  • Alle API-endepunkter skal fĂžlge RESTful konvensjoner
  • Bruk snake_case for databasefelter og tabellnavn
  • Logg alltid med strukturert logging (f.eks. winston), ikke console.log
  • FeilhĂ„ndtering skal alltid bruke egne Error-klasser
  • Bruk miljĂžvariabler for konfigurasjon, aldri hardkodede verdier

Domenekunnskap:

  • AFP = Avtalefestet Pensjon (et pensjonsprodukt)
  • NOTP = Ny Offentlig Tjenestepensjon
  • Regulering = Årlig justering av pensjonsytelser i trĂ„d med lĂžnns- og prisvekst.

Tekniske valg:

  • Vi bruker SPK Design System og Tailwind
  • Testing gjĂžres med Jest, ikke Mocha
  • Database: Microsoft SQL Server
  • Alle datoer hĂ„ndteres i Europe/Oslo tidssone med ISO 8601 format

KI-oppfĂžrsel:

  • Svar kort og presist uten unĂždvendige bekreftelser
  • Bruk norske kommentarer i kode som hĂ„ndterer norske fagbegreper
  • Bruk JSDOC pĂ„ alle funksjoner og metoder over fire linjer

Hvorfor er dette nyttig?

  • ✅ Konsistente kodeforslag som matcher din kodebase
  • ✅ FĂŠrre forslag som bruker feil rammeverk eller biblioteker
  • ✅ Bedre forstĂ„else av fagterminologi og domenekonsepter
  • ✅ Spar tid ved Ă„ slippe Ă„ forklare samme ting om og om igjen

Kom i gang

  1. Opprett .github/copilot-instructions.md i rotmappen til prosjektet
  2. Legg til relevant kontekst for ditt team/prosjekt
  3. Commit og push - ferdig! 🎉

Copilot vil nÄ automatisk ta hensyn til denne konteksten i alle svar.

Eksempel fra et av vÄre prosjekter

I self-service-repo har vi for eksempel lagt til:

Generelle retningslinjer:

  • UnngĂ„ unĂždvendige unnskyldninger eller bekreftende utsagn
  • Svar pragmatisk og fokuser pĂ„ oppgaven
  • Tenk kritisk hvis du fĂ„r beskjed om at du tar feil

Kodestandarder:

  • Bruk camelCase for variabler og funksjoner i TypeScript/JavaScript
  • Bruk kebab-case i YAML-filer
  • Bruk PascalCase for komponenter
  • Bruk UPPER_CASE for miljĂžvariabler
  • Maks 100 tegn per linje
  • Alltid bruk SHA med versjon-kommentar nĂ„r du refererer til GitHub Actions
  • Alltid bruk Maven Wrapper for Maven-kommandoer

Testing:

  • Test alltid den faktiske implementasjonen, ikke kopier av koden
  • Legg testressurser i separate filer, ikke inline tekst-blokker

Dette sikrer at Copilot foreslÄr kode som fÞlger prosjektets standarder og beste praksis.

Oppsummering

Ved Ă„ lage en .github/copilot-instructions.md fil kan du gi Copilot viktig kontekst om ditt prosjekt som:

  • Kodestandarder og konvensjoner
  • Domenespesifikk terminologi
  • Teknologivalg og arkitektur
  • Ønsket oppfĂžrsel fra KI-assistenten

Resultatet er mer presise og relevante kodeforslag som sparer deg for tid og reduserer feilkilder.

Har du spĂžrsmĂ„l eller tips til hva som fungerer godt i deres prosjekter? Del gjerne! 💬

Be notified of new posts. Subscribe to the RSS feed.