Add contributors guidelines to template

Offen

#614 erstellt am 02.2.2026 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 2/5
Geschätzter Aufwand: 1-3 Stunden
Anfängerfreundlichkeit: 55/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: documentation, tooling

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

enhancement

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

Vorherrschende Sprache: Python
Sterne: 62
Forks: 10
Ø Merge: 7 T. 6 Std.
Gemergte PRs (30 T.): 6

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus UCL-ARC/python-tooling

Consider adding `zizmor` prek hook with GHA analysis Offen

enhancement investigate p3-medium

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 48/100

UCL-ARC/python-tooling#623 · 1 Reaktion · Erstellt am 30.3.2026
Given that we are using `uv`, should the template include a `uv.lock`? Offen

enhancement p3-medium question task

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 38/100

UCL-ARC/python-tooling#620 · Erstellt am 27.2.2026
Switch from MkDocs to Zensical Offen

task

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100

UCL-ARC/python-tooling#619 · Erstellt am 27.2.2026
Switch to `ubuntu-slim` for some jobs Offen

enhancement p4-low task

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 25/100

UCL-ARC/python-tooling#616 · Erstellt am 05.2.2026
Should we drop `tox`? Offen

question website

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

UCL-ARC/python-tooling#599 · 3 Kommentare · Erstellt am 21.1.2026

Alle Issues in UCL-ARC/python-tooling