Post-migration Devguide reorganization
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 2.1k
- Forks
- 1k
- Ø Merge
- 2 T. 12 Std.
- Gemergte PRs (30 T.)
- 12
Beschreibung
I think the Devguide is due for some reorganization after the migration.
In particular:
- The version control setup section should link to a separate "git" page (either the pullrequest or the committing page -- see below). (see #265)
- The compile and build section should be reorganized. (see #412)
- The lifecycle of a PR page seems to expand on the quick start, but doesn't include detailed setup instructions and git commands. This page seem to be aimed at contributors (see #265). Also the Generation section should be under Preparation, alongside another subsection about running tests.
- The runtests page expands on a paragraph pullrequest/preparation.
- The silence warnings and fixing easy issues are both 2-paragraphs pages that might be moved as sections of other pages.
- The tracker and triaging page should be updated and perhaps merged (see #308 and #339).
- The where to get help and following Python's development could be merged.
- The committing page seems to be aimed to core-dev, but since now the workflow for both core devs and contributors is quite similar, it should perhaps be merged with the pullrequest page. Parts of this page should be moved to other pages, and only the content relevant to core devs should be left there. (see #262 and #263)
- The continuous integration page should be updated. (see #290)
- The experts page should be moved closer to the developers page. (see #901)
- The mercurial for git developers page is now unnecessary, and it should either be removed, or better reversed and become "git for mercurial developers". (see #258)
- The adding to the stdlib page should first list what are good and bad addictions (with examples) and then explain the process to add something (see #35).
The other pages don't have any major issue :)
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Überprüfe die im Issue aufgeführten, nicht abgehakten Devguide-Seiten, insbesondere runtests, silence warnings, fixing easy issues, help and communication channels sowie adding to the stdlib. Bestätige zunächst, welche abgeschlossenen Punkte und referenzierten Issues noch der aktuellen Website entsprechen, und ermittle dann die verbleibenden Seitenverschiebungen und Inhaltsaktualisierungen. Als erledigt gilt, dass eine vereinbarte Neuorganisation umgesetzt ist und die betroffenen Links und die Navigation weiterhin konsistent sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- git, python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100