Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
LSprengers opened this issue Jul 25, 2024 · 0 comments

Comments

@LSprengers
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant