-
Notifications
You must be signed in to change notification settings - Fork 2
Kontribuering
Hvis du synes Arduinomon er interessant og ønsker å bidra, er du mer enn velkommen! Det er forskjellige måter å bidra, men hovedsakelig kan du sende inn "issues" eller bidra med kode. For å holde prosjektet og repoet rent og velutviklet er det imidlertid retningslinjer for hvordan du gjør det riktig.
Hvis du har oppdaget et problem med Arduinomon, må du først forsikre deg om at det ikke er noen feil på din side. Den beste måten å validere dette på er å bruke Serial Monitor'en i Arduino IDE. Koden er bygget opp til å printe ut feilmeldinger, og disse vil du se her. Loggen i webserveren din kan også indikere potensielle problemer.
Hvis ingen feilmeldinger blir printet ut men du fortsatt har problemer, kan du sende inn en issue. Eller enda bedre sende inn en pull request med en løsning.
Sjekk om problemet ditt ikke allerede eksisterer ved å søke i eksisterende issues
Les hvordan du sender inn en issue hvis du ikke allerede er kjent med det: https://help.github.com/no/articles/creating-an-issue
Gi følgende informasjon for å gjøre problemet klart og forståelig:
Gi en klar tittel
En tydelig tittel gjør det enkelt å forstå problemet.
Beskriv problemet
En tydelig og kortfattet beskrivelse av hva problemet er.
Fremgangsmåte
Fremgangsmåte for å gjengi hvordan problemet oppsto.
For eksempel: Arduinoen registrerte kast, men ingen data blir sendt til databasen. Serial Monitor printer ikke ut feilmelding, og webserver logg er tom.
Forventet oppførsel
En tydelig og kortfattet beskrivelse av hva du forventet skulle skje.
Tilleggskontekst
Legg til noen annen kontekst om problemet her, f.eks. logger eller HTTP-feil.
Det er alltid ønskelig hvis du er interessert i å bidra med kode eller videreutvikle Arduinomon! Send inn en pull request med ditt bidrag eller kontakt meg: [email protected]
Hvis du vil jobbe med en issue, tilordner du deg issuet slik at vi vet hva du jobber med.
Når du bidrar med kode, send inn en pull request. Hvis du ikke er kjent med det, kan du lese om hvordan du gjør det her: https://help.github.com/no/articles/creating-a-pull-request
Kodekonvensjoner
Det er noen konvensjoner du må følge for å sikre konsistens når du skriver kode for Arduinomon:
- Bruk "tabs" med fire innrykk
- "Brace placements" er alltid på samme linje
- Kommentarer er plassert på en egen linje
- camelCase