10000 Restructuration du README.md · Issue #1023 · python/python-docs-fr · GitHub
[go: up one dir, main page]

Skip to content

Restructuration du README.md #1023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
8000 Kydlaw opened this issue Nov 22, 2019 · 0 comments · Fixed by #1024
Closed

Restructuration du README.md #1023

Kydlaw opened this issue Nov 22, 2019 · 0 comments · Fixed by #1024
Labels

Comments

@Kydlaw
Copy link
Contributor
Kydlaw commented Nov 22, 2019

Le README.md actuel contient énormément d'informations (ce qui est un point extrêmement positif). Cependant, comme mentionné dans #1021, il manque de structure et d'organisation des informations pour le visiteur.

Les principaux problèmes évoqués jusqu'à présent sont :

  • de nombreux outils évoqués à différents endroits du document (powrap est mentionné au début, au milieu des commandes Git, puis on en retrouve d'autes outils après le glossaire) sans que l'on sache nécessairement quels sont leurs intérêts respectifs.
    Il serait intéressant de mentionner pogrep (mentionner pogrep dans le README #1021).
    La mention de padpo devra sans doute suivre lorsque l'outil sera plus mature.

  • La partie sur la touche de composition et les caractères spéciaux occupe une grosse partie du document. Cette partie pourrait être réduite en 1) expliquant d'abord la touche de composition et comment la définir puis 2) mentionner les caractères propres au français. Comme la touche de composition est déjà évoqué en premier lieu, la deuxième partie prendrait beaucoup moins de place.

La solution retenue dans un premier temps (et qui sera discutée au moment de la PR) est de créer un fichier CONTRIBUTION.md qui reprend les éléments propres à la contribution et garder dans le README.md uniquement les informations génériques.

Soit une répartition qui se rapprocherait de :

README.md :

Historique du projet
Guide sur comment contribuer (quelques informations génériques puis lien vers CONTRIBUTION.md)
Accord de contribution à la documentation

CONTRIBUTION.md

Contribuer en utilisant Github : pas à pas
Que traduire
Les outils utiles pour traduire (les indispensables, les moins indispensables)
Saisir du français valide : touche de composition
    Les caractères auxquels il faut prêter attention.
Ressources utiles
Glossaire

N'hésitez pas suggérer des changements de contenu autre que l'intégration de pogrep. Par exemple, y-a-t-il des outils que vous souhaitez voir retirer ? Ou ajouter ? D'autres instructions à développer ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants
0