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

Confusing steps in 1-add-headers.md #246

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gabrielryanft
Copy link

The steps in 1-add-headers.md were a bit confusing regarding the PR process.

Summary

In the instructions to create a pull request, there is only one step saying "Click Create pull request."

But there are two "Create pull request" buttons.

And something that make the process a bit more confusing for the learner is that when you click in the first Create pull request button:

===

first-pr-btn

===

You go to a page (Wrong page, you would need to click in the second Create pull request button to go to the right one.) that have a "files changed" field, and the file index.md:

===

files-changed

===

Ok, it is not a tab (in the steps it is saying to click in a tab), but a learner without much experience, would think that it is the right one.

And the index.md present in that page is not editable yet, so, as pointed by hadder94, (in the issues page) when you click in the menu, the option to edit it grayed out.

Changes

So, to solve this, i recommend putting something similar to what i did.

To make it very clear to the learner, that it is necessary to create a PR.

Giving the instructions to interact with the title of the PR and create it, clicking again in the "Create pull request" button:

===

second-pr-btn

===

Related issues:

#245 (comment)

The steps in 1-add-headers.md were a bit confusing regarding the PR process.
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

Successfully merging this pull request may close these issues.

1 participant