nushell / nushell/nushell.github.io
Improve the user flow for editing the (autogenerated) docs
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 258
- Forks
- 561
- Ø Merge
- 3 Std. 20 Min.
- Gemergte PRs (30 T.)
- 15
Beschreibung
The Nushell website has links at the bottom of the page to "Edit this page on GitHub". Clicking the link takes the user through the process of updating that page using the GitHub web interface to create a pull request. That user flow bypasses the CONTRIBUTING.MD and it's not until after the PR is submitted the user is notified about not updating autogenerated docs.
Some suggestions to improve this for first time contributors.
- Remove the "Edit this page on GitHub" links on pages that should not be edited.
- Change or create the GitHub issue template specifying that certain pages, trees roots or paths should not be modified.
- Add a note about contributing to the README.md. As it is, the user is expected to know about the CONTRIBUTING.md document.
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
Lies zuerst README.md und CONTRIBUTING.md, untersuche dann, wie die Website ihre „Edit this page on GitHub“-Links hinzufügt und wie GitHub-Issue-Templates konfiguriert sind. Die Arbeit ist abgeschlossen, wenn Seiten, die nicht bearbeitet werden sollten, diese Links nicht mehr anzeigen, das Issue-Template automatisch generierte Pfade kennzeichnet und README.md Mitwirkende auf die Hinweise zum Beitragen verweist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- github
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100