UCL-ARC / UCL-ARC/python-tooling

Add contributors guidelines to template

Aperta
#614 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Python
Stelle
62
Fork
10
Merge medio
7g 6h
PR unite (30g)
6

Descrizione

Is Your Feature Request Related to a Problem? Please Describe

Currently the package template does not include a CONTRIBUTING.md guidelines page, but this is quite a well suited page for templating given a basic guide can use largely pro-forma text with a few templated links. While it will need to be relatively generic, I think having something basic included by default in template would be good.

Describe the Solution You'd Like

A CONTRIBUTING.md contributors guide in the cookicutter template. We added a basic guide to S2FFT recently which could be used as starting point (as could probably many others this one is just recent in memory!).

Describe Alternatives You've Considered

No response

Additional Context

No response

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Start by locating the cookiecutter package template and reviewing the linked S2FFT CONTRIBUTING.md guide as a possible model. Add a generic CONTRIBUTING.md with templated links, then verify that newly generated Python packages include the guide and that its links are appropriate for the template.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.