At skabe et open source projekt

At skabe et open source projekt

Her er din guide for, hvordan du kreerer et open source projekt. Guiden kommer fra Open Source Guides og OS2 har sidenhen oversat den til dansk med nogle tilpasninger. Grundlæggende OS2 er et fællesskab, hvor medlemmer finder sammen med visionen om at løse et behov, de har, eller at leverandører foreslår en løsning f.eks. på et afklaringsmøde. Vil du vide mere end guiden kan give dig, så kontakt OS2-sekretariatet.

 

INDHOLDSFORTEGNELSE

Har du open source på hjernen?

Gratis?

Et nyt projekt

Hvad skal være med?

Hvad kalder vi barnet?

Tjektlisten

 

Har du open source på hjernen?

Tillykke! OS2-fællesskabet vil takke dig for dine nutidige og/eller fremtidige bidrag. I OS2-fællesskabet er vi sammen om at skabe it-løsninger, så fuld gennemsigtighed i software en dag kan blive en selvfølgelighed i det offentlige it-landskab i Danmark.

Men hvad betyder open source? Det betyder, at alle har ret til at se, bruge, ændre og distribuere dit projekt til ethvert formål (så længe licenskriterier er opfyldt). Open source er giver alle idéer en mulighed for at blive spredt vidt og bredt – og hurtigt.

 

Et lille eksempel:

  • Du laver en kage og deler den med alle din venner.
  • Alle prøver kage (brug)
  • Kagen er et hit. Din venner spørger efter opskriften, som du giver dem (se)
  • En af dine venner, Line, foreslår at reducere mængden af sukker (ændre)
  • En anden ven, Peter, spørg om han må bruge den til en middag i næste uge (distribuere)

Der er mange grunde til at folk deltager i et open source fællesskab. Det kan være for at gøre ting bedre i fællesskab for at være med i innovationen, når der vokser nye projekter ud eller for gennemsigtighedens skyld.

 

Gratis?

Når open source er gratis, er det en bivirkning af den samlede værdi i open source. Gratis er ikke en del af definitionen. I stedet kræver open source licenser af alle kan bruge, ændre og dele dit projekt, og derfor er projekterne typisk gratis. Hvis de ikke var, ville alle lovligt kunne lave en kopi og bruge den gratis version i stedet.

 

Et nyt projekt

Når du starter et nyt open source/OS2 projekt, er der flere ting du skal være opmærksom på. Først og fremmest skal du have rygdække fra din kommune/region/anden offentlige myndighed. Det kræver som minimum et klart mål, der peger på det behov, som du vil løse samt en idé til at løse det. Du skal også bruge en gruppe, som du kan finansiere projektet med. Det finder du i OS2, f.eks. ved møder med andre kommuner/regioner/andre og/eller et afklaringsarrangement.

I bund og grund bør du starte dit OS2-projekt, når du er klar til at få andres perspektiv og feedback på din idé.

 

Hvad skal være med?

Ethvert open source projekt skal indeholde følgende:

  • Open source licens (OS2 bruger MPL og CC-BY-SA)
  • README
  • Guidelines for bidrag
  • Code of Conduct (her følges OS2s Code of Conduct)

 

README:

READMEs forklarer hvordan man bruger dit projekt, hvorfor dit projekt er vigtigt og hvad dine brugere kan gøre ved det. En README indeholder typisk svar på følgende spørgsmål:

  • Hvad gør projektet?
  • Hvorfor er det brugbart?
  • Hvordan kommer man i gang?
  • Hvor kan man få mere hjælp?

Guidelines for bidrag:

En CONTRIBUTING file fortæller dit publikum, hvordan de kan deltage i dit projekt. Det kunne indeholde informationer om:

  • Hvordan man rapporterer en fejl
  • Hvordan man foreslår en ny feature
  • Hvordan man opsætter tests.

Desuden er CONTRIBUTING filen en mulighed for at kommunikere, hvilken typer bidrag du leder efter, din vision med projektet, hvordan bidragsydere skal/skal ikke komme i kontakt med dig, osv.

Hold en god tone, så vil bidragsydere føle sig mere velkommen og begejstrede for at deltage.

Code of Conduct:

OS2 har en code of conduct, som gælder ved udvikling af open source software. En code of conduct sætter reglerne for opførsel i fællesskabet. Det er en måde at skabe og bibeholde en sundhed og behagelig stemning i udviklingsfællesskabet.

Husk at linke til OS2s code of conduct fra README og CONTRIBUTING filen.

 

Hvad kalder vi barnet?

OS2 har en skabelon for logoer, hvor projekter i modning har orange tekst og produkter har grøn tekst. OS2-sekretariatet vil være behjælpelige med at lave logoet for dit projekt, når det er optaget i OS2.

Vælg et navn som beskriver projektet, f.eks. er OS2udoglær en portal for læringstilbud ude af huset og OS2indberetning er apps for indberetning af kørsel og ferie. Men også gerne et der er lidt mundret.

Dit projekt får selvfølgelig en plads på OS2s hjemmeside, hvor OS2-sekretariatet vil være i kontakt med dig for at finde den rette beskrivelse til projektsiden, så alle ved, hvad projektet omhandler.

 

Tjeklisten

Er du klar til at komme ud over stepperne? Tjek med denne liste:

  • Projektet har open source licens (MPL & CC-BY-SA)
  • Projektet har den grundlæggende dokumentation (README, CONTRIBUTING, CODE_OF_CONDUCT)
  • Navnet kommer ikke i konflikt med andre brands/projekter
  • Issuekøen er up-to-date og issues er organiseret og mærket i Jira
  • Projektet er konsekvens i sin brug af kode konventioner
  • Koden er veldokumenteret og kommenteret
  • Der er ikke følsomme oplysninger i revisionshistorien, issues eller pull requests i Jira
  • OS2-sekretariatet er klar til at promovere dit projekt

 

Tillykke med det nye projekt. Må det skabes og udvikles i et godt samarbejde og brede sig til alle de OS2-medlemmer, der har et behov for det.

Om vejledningen

Om samlingen

Log ind

CAPTCHA
Da vi ikke har en robot til at slette spam forsøger vi at sikre os. Dette spørgsmål er en test for at se om du er en menneskelig besøgende.