Dette er en autogenerert issue, laget av et skript som går gjennom alle NAV sine kodebaser på Github og gjør diverse sjekker. Her er en liste over ting som må endres.
På Github kan man gi hver kodebase en kort beskrivelse. Denne bør fortelle hva kodebasen heter, og litt om hva den brukes til. (Eksempel: kodebasen "veilarbportefoljeflatefs" har beskrivelse "Oversikt for veiledere over oppfølgingsbrukere".)
NB! Dette gjelder ikke beskrivelse i en README-fil, det gjelder beskrivelse i metadataen til selve Github-repoet.
Kodebasen mangler en README.md-fil
Bruk denne malen, tilpass navn og beskrivelse på prosjektet, byggemåte, kontaktinformasjon og så videre.
Kodebasen mangler en CODEOWNERS-fil
Dette er en fil som skal ligge i rotkatalogen, og angir hvilket team som eier kodebasen, på et maskinlesbart format. Den enkleste varianten, som vil holde for de fleste, er å ha en CODEOWNERS-fil som ser slik ut: (Merk at det skal være asterisk/stjerne foran navn på teamet!)
Når alle endringer er gjort, så kan denne saken lukkes.
Spørsmål og svar
Jeg har meninger om disse rådene - kan jeg komme med tilbakemeldinger?
Skriv i vei, på Slack-kanalen #open-source.
Kodebasen vår er ikke open source, derfor er det ikke noe poeng
Selv om koden i dag ikke er åpen for innsyn, så ta høyde for at den kan komme til å bli det i fremtiden. Uansett så vil forbedringene være til hjelp, enten kodebasen er åpen eller ei!
Hvem har ansvaret for å fikse det her?
Det er i utgangspunktet den/de/teamet som eier kodebasen som må fikse.
Dette er en autogenerert issue, laget av et skript som går gjennom alle NAV sine kodebaser på Github og gjør diverse sjekker. Her er en liste over ting som må endres.
Kodebasen mangler en LICENSE.md-fil
Alle kodebasene til NAV skal (i utgangspunktet) lisensieres med MIT-lisens. Bruk den lisensen her: https://github.com/navikt/offentlig/blob/master/LISENSIERING.md
Beskrivelse mangler
På Github kan man gi hver kodebase en kort beskrivelse. Denne bør fortelle hva kodebasen heter, og litt om hva den brukes til. (Eksempel: kodebasen "veilarbportefoljeflatefs" har beskrivelse "Oversikt for veiledere over oppfølgingsbrukere".) NB! Dette gjelder ikke beskrivelse i en README-fil, det gjelder beskrivelse i metadataen til selve Github-repoet.
Kodebasen mangler en README.md-fil
Bruk denne malen, tilpass navn og beskrivelse på prosjektet, byggemåte, kontaktinformasjon og så videre.
Kodebasen mangler en CODEOWNERS-fil
Dette er en fil som skal ligge i rotkatalogen, og angir hvilket team som eier kodebasen, på et maskinlesbart format. Den enkleste varianten, som vil holde for de fleste, er å ha en CODEOWNERS-fil som ser slik ut: (Merk at det skal være asterisk/stjerne foran navn på teamet!)
Gyldige teamnavn på Github er:
@navikt/academy
(academy)@navikt/ai
(AI)@navikt/alf
(ALF)@navikt/apen-kildekode
(Åpen kildekode)@navikt/arbeidsflate
(Arbeidsflate)@navikt/atom
(atom)@navikt/aura
(aura)@navikt/baseimage
(baseimage)@navikt/bidrag
(Bidrag)@navikt/biff
(biff)@navikt/bos
(bos)@navikt/bris
(bris)@navikt/core
(Core)@navikt/dagpenger
(Dagpenger)@navikt/database
(database)@navikt/datajegerne
(datajegerne)@navikt/dataplattform
(dataplattform)@navikt/design
(Design)@navikt/developers
(Developers)@navikt/di-pt-sak
(di-pt-sak)@navikt/didep
(didep)@navikt/digisos
(DIGISOS)@navikt/digisyfo
(Digisyfo)@navikt/dittnav
(DittNAV)@navikt/dolly-freg
(Dolly-freg)@navikt/drage
(drage)@navikt/drops
(Drops)@navikt/dsopkontroll
(dsopkontroll)@navikt/dusseldorf
(dusseldorf)@navikt/eessi-basis
(EESSI Basis)@navikt/eessi-pensjon
(eessi pensjon)@navikt/engineering-productivity
(Engineering Productivity)@navikt/europeisk-helsekort
(Europeisk Helsekort)@navikt/eux
(eux)@navikt/familie
(familie)@navikt/foreldrepenger
(Foreldrepenger)@navikt/forenklet-oppfolging
(forenklet oppfølging)@navikt/fp-faggruppe
(fp-faggruppe)@navikt/fpsak-frontend
(FPSAK Frontend)@navikt/gjenlevende
(gjenlevende)@navikt/helse
(helse)@navikt/identitet-sikkerhet
(identitet-sikkerhet)@navikt/idm
(IDM)@navikt/informasjon-og-veiledning
(Informasjon og veiledning)@navikt/infotrygd
(Infotrygd)@navikt/integrasjon
(Integrasjon)@navikt/intern-samhandling
(Intern samhandling)@navikt/jfb2019
(JFB2019)@navikt/kafkaadmins
(kafkaadmins)@navikt/kuhr-helse
(kuhr-helse)@navikt/linuximage
(linuximage)@navikt/melosys
(Melosys)@navikt/melosys-java
(melosys-java)@navikt/mobilarbeidsplass
(MobilArbeidsplass)@navikt/nav-frontend-admins
(nav-frontend-admins)@navikt/nav-labs
(NAV-labs)@navikt/okonomi
(Okonomi)@navikt/onyx
(onyx)@navikt/opendata
(opendata)@navikt/oppfolging
(Oppfølging)@navikt/oppfolging-person
(Oppfølging person)@navikt/oppgavehandtering
(Oppgavehåndtering)@navikt/pam
(PAM)@navikt/pam-klan-j
(pam-klan-j)@navikt/pam-team-aasmund
(pam-team-aasmund)@navikt/pam-team-tuan
(pam-team-tuan)@navikt/paranoia
(paranoia)@navikt/pentest
(pentest)@navikt/personbruker
(Personbruker)@navikt/persondata
(Persondata)@navikt/personopplysninger
(Personopplysninger)@navikt/personoversikt
(personoversikt)@navikt/pesys
(pesys)@navikt/pim
(pim)@navikt/pus
(pus)@navikt/redaktorer
(redaktører)@navikt/samordning
(samordning)@navikt/selvbetjening-core
(selvbetjening-core)@navikt/sosialtjenester
(Sosialtjenester)@navikt/synt
(Synt)@navikt/tbd
(tbd)@navikt/team-arbeid
(Team Arbeid)@navikt/team-arena
(Team Arena)@navikt/team-oppfolging-fo
(Team oppfølging - FO)@navikt/team-register
(Team Register)@navikt/team-soknad
(Team søknad)@navikt/teampeon
(teampeon)@navikt/teamsykefravr
(teamsykefravr)@navikt/teamtag
(teamtag)@navikt/test_test
(Test_Test)@navikt/traktor
(Traktor)@navikt/warp
(WARP)Her er en oppdatert liste over team i Github. Mangler teamet deres i lista? Ta kontakt med noen i Core-teamet på Github, så kan de opprette et team til dere.
Hvis det trengs spesielle tilpasninger, så ligger det mer dokumentasjon om CODEOWNERS-filformatet her:
https://help.github.com/articles/about-codeowners/
Når alle endringer er gjort, så kan denne saken lukkes.
Spørsmål og svar
Jeg har meninger om disse rådene - kan jeg komme med tilbakemeldinger?
Skriv i vei, på Slack-kanalen #open-source.
Kodebasen vår er ikke open source, derfor er det ikke noe poeng
Selv om koden i dag ikke er åpen for innsyn, så ta høyde for at den kan komme til å bli det i fremtiden. Uansett så vil forbedringene være til hjelp, enten kodebasen er åpen eller ei!
Hvem har ansvaret for å fikse det her?
Det er i utgangspunktet den/de/teamet som eier kodebasen som må fikse.
Det er en feil i rådene
Alle roboter gjør jo feil, denne også. Lag en issue på https://github.com/navikt/repo-linter.