Update GH PR Guide Page

Offen
#73 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
65/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
git, github
Bereich
documentation

Rechercherichtung

Beginne mit der verlinkten GitHub PR Guide-Seite und vergleiche deren erste beiden Abschnitte mit den aktuellen Updates von GitHub, wobei du dich auf Screenshots, die Auswahl von Reviewern und Branch-Schutz konzentrierst. Füge den angeforderten Abschnitt „4. Merge Your Pull Request“ mit den bereitgestellten Anleitungen zu squash-merge und branch-scoping hinzu; die Arbeit ist abgeschlossen, wenn diese Updates und der neue Abschnitt korrekt auf der Guide-Seite wiedergegeben sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation enhancement

Further updates to the first two sections of the GitHub PR Guide are still needed to align with GitHub's recent updates, though this is more about updating screenshots than actual content. There are a few more features that may be worth highlighting, but a major overhaul is not required.

One more thing to note in that section is actually picking a reviewer or reviewers, i.e., that it should be those that are most familiar with the content after the author and that they must have write access to the repo for it to satisfy branch protections (arguably, this should be covered by most familiar with content).

Additionally (pulling from a discussion in a private repo), let's make a section: "4. Merge Your Pull Request" which will include information about the merging options.

Basics on Squash Merge from @johnbradley's original Two Repo problem draft:

  • Often there are many messy commits that should be reduced to meaningful commits.
  • One easy way to reduce the messy commits into a single commit is using a Squash and merge Pull Request.

Paired with the scope note mentioned in my comment:

We should be sure to emphasize the fact that once a branch is squash merged into main, it can't continue to be used for development, so they should be scoped. Also, that they should be scoped so the squash merge makes sense and can still be used to tell the story (for instance, one feature change and the associated adjustments to tests).

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.