CONTRIBUTING.md not created or staged when it is brought up in chapter 2.2

Aperta
#1,964 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
50/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
git
Ambito
documentation

Direzione di ricerca

Review chapter 2.2, especially the section on staging modified files and its CONTRIBUTING.md example. Check the walkthrough from a fresh reader’s perspective, then ensure the text explicitly accounts for creating and staging the file. Done means the instructions can be followed without an unstated step.

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

Descrizione

enhancement
General overview of your idea.

Maybe I am being dense, but if I am not mistaken. In chapter 2.2 under staging modified files. CONTRIBUTING.md is brought up, yet no such file has been created at this point and neither has it been staged yet.

Doing so is very straightforward but...

Let’s change a file that was already tracked. If you change a previously tracked file called CONTRIBUTING.md and then run your git status command again, you get something that looks like this:

...does not imply that you need to do these steps. Rather it implies that the reader has missed a step and should already have a created and staged CONTRIBUTING.md file.

A solution would be a snippet of code to create and stage CONTRIBUTING.md or explicit instructions to make and stage such a file in the text.

It goes without saying but thanks for the great resource. :)

What problem will this solve?

re-enable the reader to follow along with the instructions provided by the book.

Have you thought about other solutions?

Another solution would be to more explicitely tell the user to create and stage the CONTRIBUTING.md themselves.

Do you want to help with this enhancement idea?

No

Lingua principale
CSS
Stelle
6.6k
Fork
2.1k
Nessuna PR unita negli ultimi 30g

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 progit/progit2

Tutte le issue di progit/progit2

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.