nushell / nushell/nushell.github.io
The contributing notes for the nu website is missing a style guide
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 258
- Forks
- 561
- Ø Merge
- 3 Std. 20 Min.
- Gemergte PRs (30 T.)
- 15
Beschreibung
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"
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
Beginne damit, die Hinweise zum Beitragen für die Website und die Buchinhalte, die sie abdecken, zu finden. Dokumentiere konsistente Nu-Codeblock-Bezeichnungen und einen einheitlichen Stil für die Tabellenausgabe und prüfe anschließend die umgebenden Beispiele, um sicherzustellen, dass die Anleitung klar und anwendbar ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- shell
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 50/100