CONTRIBUTING.md not created or staged when it is brought up in chapter 2.2
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 50/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- git
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.mdand 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
- Lenguaje dominante
- CSS
- Estrellas
- 6.6k
- Forks
- 2.1k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de progit/progit2
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Semi-stale link for GitHosting Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
enhancement
Dificultad 1/5 Menos de una hora Aptitud para principiantes 82/100
-
enhancement
Dificultad 1/5 1-3 horas Aptitud para principiantes 65/100
Todos los issues de progit/progit2
Issues similares
-
Link Checker Report Abiertoautomated issue report
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Humanity AI Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
numfocus/project-fundraising#166 ·
-
area:proxy bug security severity:low track:open-source
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100