carpentries-incubator / carpentries-incubator/python-intermediate-development
Improvements for instructions on opening a pull request
- Vorherrschende Sprache
- TeX
- Sterne
- 63
- Forks
- 77
- Ø Merge
- 20 Std. 8 Min.
- Gemergte PRs (30 T.)
- 3
Beschreibung
## 1. Merge to main or dev?
In this paragraph 'Raising a pull request': https://carpentries-incubator.github.io/python-intermediate-development/41-code-review/index.html#raising-a-pull-request . In point 4 we say: Select the base and the compare branch - main and feature-std-dev, respectively. In the screenshots the merge is to the `dev` branch however. I would suggest to merge into `dev` here.
## 2. Adapt for forked repo
The screenshots and instructions show the situation in the original repo. But participants work in a forked repo. The screenshots should reflect this. And make it very clear that they should not open a PR to the forked repo, which is the default in GitHub.
Beitragsleitfaden
Rechercherichtung
Öffne den verlinkten Abschnitt „Raising a pull request“ und prüfe Punkt 4 sowie die zugehörigen Screenshots. Bestätige den vorgesehenen Basis-Branch und aktualisiere anschließend die Formulierung zum Branch sowie die Hinweise zum Fork, sodass der PR auf das ursprüngliche Repository und nicht auf den Fork zielt. Ersetze die Screenshots entsprechend diesem Workflow und überprüfe die gerenderte Lektion.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- github
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100