Clarify commit suggestions

Offen
#39 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
Ein halber Tag
Anfängerfreundlichkeit
45/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
git
Bereich
documentation

Rechercherichtung

Beginnen Sie mit dem verlinkten Abschnitt „Formatting and Naming Conventions“ im Collaborative Distributed Science Guide und prüfen Sie dessen aktuelle Hinweise zu Commits. Als abgeschlossen gilt die Aufgabe, wenn der Abschnitt den Zweck von Commit-Nachrichten, die Lesbarkeit und das Verständnis der durchgeführten Arbeit klar erklärt, dabei auf gute maschinenlesbare Commit-Praktiken verlinkt und hervorhebt, warum Änderungen vorgenommen werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

design documentation help wanted question

The Formatting and Naming Conventions section could use a re-visit. I think we need to elevate the commit portion, but also make it more in-line with practice. We should summarize the purpose of commit messages, highlighting important aspects of readability and understanding processes done. Then also link to good practices for, e.g., machine-readability and such, but the ultimate goal of understandable commits (why is this change happening) needs to be expressed clearly.

Vorherrschende Sprache
Python
Sterne
1
Forks
1
Ø Merge
6 T. 1 Std.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

Erste Schritte

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

Mehr aus Imageomics/Collaborative-distributed-science-guide

Alle Issues in Imageomics/Collaborative-distributed-science-guide

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.