Update GH PR Guide Page

Aperta
#73 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
65/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
git, github
Ambito
documentation

Direzione di ricerca

Inizia dalla pagina GitHub PR Guide collegata e confronta le sue prime due sezioni con gli aggiornamenti recenti di GitHub, concentrandoti sugli screenshot, sulla selezione dei reviewer e sulle protezioni dei branch. Aggiungi la sezione richiesta “4. Merge Your Pull Request” usando le indicazioni fornite su squash-merge e branch-scoping; il lavoro è completato quando questi aggiornamenti e la nuova sezione sono riportati accuratamente nella pagina della guida.

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

Descrizione

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).

Lingua principale
Python
Stelle
1
Fork
1
Merge medio
6g 1h
PR unite (30g)
1

Preparare l'ambiente

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 Imageomics/Collaborative-distributed-science-guide

Tutte le issue di Imageomics/Collaborative-distributed-science-guide

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.