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

Conflicting Instructions in README vs Github Desktop Tutorials #96053

Open
t-schneids opened this issue Mar 31, 2025 · 3 comments
Open

Conflicting Instructions in README vs Github Desktop Tutorials #96053

t-schneids opened this issue Mar 31, 2025 · 3 comments

Comments

@t-schneids
Copy link
Contributor

While following the instructions to complete my first pull request, I noticed conflicting instructions in the README vs Github Desktop Tutorials. It is a very minor issue, but it did cause a little bit of confusion.

🐞 Problem

In the README, under the section "Make necessary changes and commit those changes", it instructs users: "Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file." Essentially, add your name in the middle of the Contributors.md file.

However, in the Github Desktop instructions (what I used), under the section "Make necessary changes and commit those changes", it instructs users: "Scroll to the bottom of the page and add your name to it, then save the file." Essentially, add your name to the end of the file.

These two sets of instructions conflict each other and can confuse first time using.

🎯 Goal
To lessen confusion for future new contributors, one of these files should be updated to match the other.

💡Solution
The solution itself is a simple update to the documentation for one of these pages so that it matches the other.

❌ Concerns
I am not sure which one of the tutorials is correct, so I am not certain which one of the files should be switched.

Is a change like this something anyone can attempt and submit a pull request for?

@soham20008
Copy link

Hello!
I am a beginner in open source. I want to resolve this issue as my first contribution But I cannot figure out how to do it I find the "Make necessary changes and commit those changes" in README section but I cannot find the "GitHub Desktop instructions" Can any one help me or guide me..

@brambhattabhishek
Copy link

/assign

@vaibhavyxx
Copy link

Hi, I can't link my pull request to the development but just now sent a pull request with that fix! #96227

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

No branches or pull requests

4 participants