Add Contributing.md or other resource for potential contributors

Aperta
#17 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
c
Ambito
documentation

Direzione di ricerca

The issue asks for a contributor guide at the repository root, so the new file is a Markdown document and no code changes. Start by reading the CI configuration and any commit or style checks the repository runs, since the issue says those requirements are undocumented. Then write the guide covering commit message rules, the checks CI enforces, and the code style used for this C project. Done when a newcomer can read the file and pass CI on a first commit without asking.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

At the moment, there are several checks on commits that are not documented anywhere (?). It would be nice to list these requirements to prevent unnecessary confusion & CI failures.

Additionally, such a document would be a good place to mention code style guidelines (if any), etc.

Lingua principale
C
Stelle
44
Fork
30
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openwrt/omcproxy

Tutte le issue di openwrt/omcproxy

Issue simili

Altre issue su C

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.