Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Improve the user flow for editing the (autogenerated) docs

Aperta
#1,722 1 commento 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
github
Ambito
documentation

Direzione di ricerca

Leggi prima README.md e CONTRIBUTING.md, quindi analizza come il sito web aggiunge i suoi link «Edit this page on GitHub» e come sono configurati i template delle issue di GitHub. Il lavoro è completo quando le pagine che non dovrebbero essere modificate non mostrano più questi link, il template della issue identifica i percorsi generati automaticamente e README.md indirizza i contributori alle indicazioni per contribuire.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

  1. Remove the "Edit this page on GitHub" links on pages that should not be edited.
  2. Change or create the GitHub issue template specifying that certain pages, trees roots or paths should not be modified.
  3. Add a note about contributing to the README.md. As it is, the user is expected to know about the CONTRIBUTING.md document.
Lingua principale
TypeScript
Stelle
258
Fork
561
Merge medio
3h 20m
PR unite (30g)
15

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di nushell/nushell.github.io

Tutte le issue di nushell/nushell.github.io

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.