Post-migration Devguide reorganization
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 2.1k
- Forks
- 1k
- Merge moyen
- 2 j 12 h
- PR mergées (30 j)
- 12
Description
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 :)
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Examinez les pages de Devguide non cochées répertoriées dans l’issue, en particulier runtests, silence warnings, fixing easy issues, help and communication channels et adding to the stdlib. Commencez par confirmer quels éléments terminés et quelles issues référencées correspondent toujours au site actuel, puis déterminez les déplacements de pages et les mises à jour de contenu restants. Le travail est considéré comme terminé lorsqu’une réorganisation approuvée est mise en œuvre et que les liens et la navigation concernés restent cohérents.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- git, python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 25/100