nushell / nushell/nushell.github.io
The contributing notes for the nu website is missing a style guide
Ouverte
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 258
- Forks
- 561
- Merge moyen
- 3 h 20 min
- PR mergées (30 j)
- 15
Description
It would also be nice to add some style guides for contributing to the book. Currently the style of e.g. code examples is a bit inconsistent. For example:
- Code examples should use the nu formatting as in
```nu, currently this is not very consistent as I seenone,bash,sh,nuandnushellused. I think it would be nice to have these consisten. - Another that might be nice is to use a consistent style for output formating of tables. E.g. "examples of table output should use rounded corners" (don't actually mean it needs to be rounded, just that we would use a consistent styling"
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
Commencez par localiser les notes de contribution du site web et le contenu du livre qu’elles couvrent. Documentez des libellés cohérents pour les blocs de code Nu et un style unique pour la sortie des tableaux, puis vérifiez les exemples environnants afin de vous assurer que les indications sont claires et applicables.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- shell
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 50/100