You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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?
The text was updated successfully, but these errors were encountered:
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..
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?
The text was updated successfully, but these errors were encountered: