Jan Ainali

Foundation for Public Code

Ni som är här

Standard for Public Code

Välj ett beskrivande namn på din kodbas

• Bättre: FixMyStreet
• Medium: OpenZaak
• Sämre: Odoo, OS2datascanner, EESSI RINA

Lägg ditt kodrepository under en särskild organisation

(inte den du jobbar på!)

Använd en fri licens och lägg till en licensfil kallad LICENSE

Uppmuntra samarbete

Avråd ifrån och undvik långlivade grenar och avknoppningar

Write all your documentation in English

Beskriv din kodbas med en kärnfull mening där den publiceras

Ex:

• Signalen/frontend - Frontend for Signalen, an application that helps cities manage and prioritize nuisance reports
• LEOS - A tool facilitating the drafting of legislative texts

Slå av möjligheten att göra 'merge to master' utan granskning

Beskriv din kodbas med ett kärnfullt stycke där den publiceras

Ex: Bumperscripter

Beskriv målet med din kodbas med ett språk som är lätt att förstå

Publicera all källkod.

Använd den källkod som är publicerad.

Använd ett ärendehanteringssystem

och om det inte är på samma plattform, länka till den

Se till att din README-fil är inbjudande, uppdaterad och välbeskrivande

Readme-mallar

Använd dig av en CONTRIBUTING-fil

Ex: Standard for Public Code

Anta och publicera en uppförandekod (CODE OF CONDUCT)

Ex: Contributor Covenant

Förklara hur beslut för kodbasen görs (exemplevis i en GOVERNANCE-fil)

Enkel mall

Förklara din kontext

Inkludera förklaring av policy, användare och processägare

Tillåt alla att göra pull requests

Ange tydligt vilken mognadsgrad kodbasen har

Möjliga benämningar

Hitta på en logotyp och kanske ett formspråk för kodbasen

Skriv eller länka till språkliga riktlinjer

Fundera på om en mall för Pull requests är till hjälp

Skapa en lista med erfarna återförsäljare av tjänster som utveckling m.m.

Ex: OS2display

Publicera en enkel bild av kodbasens arkitektur

Gör plats för en community att diskutera

Länka till den code engineering guide som bidrag bör följa

Visa exempel på kodbasens viktigaste funktioner

Skapa en snabbstartsguide för egen installation

Ex. OpenFisca country template

Skapa en snabbstartsguide för användare

Gör en lista över de olika rollerna som finns representerade i din kodbas

Ex: Inkscape

Skriv en enkel introduktion riktad till nya bidragsgivare

Lägg till en roadmap

Ex: Sharetribe

Förklara vilka som är inblandade i kodbasen

Lista alla offentliga organisationer som har replikerat kodbasen

och länka till deras instans (om det är möjligt)

Ex: Decidim

Fundera på om en mall för nya ärenden är till hjälp

API dokumentation

Förklara vilka beroenden som finns (både buildtime och runtime)

Asynkron kommunikationskanal

(mailing list/forum)

Synkron kommunikationskanal

(chat)

Detaljerad installationguide

för sysadmins

Komponentdokumentation

Informera om relevanta lagar och regelverk

Ange vilken täckningsgrad kodbasen har för sina test

Tack!

🐦 @Jan_Ainali

📨 jan@publiccode.net

🌐 publiccode.net