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

Add PR and issue requirements in 'The Steps' section #2807

Open
jholtkort opened this issue Oct 23, 2019 · 2 comments
Open

Add PR and issue requirements in 'The Steps' section #2807

jholtkort opened this issue Oct 23, 2019 · 2 comments

Comments

@jholtkort
Copy link
Contributor

Problem

In Step 0, it is mentioned that you will be required to find problems with the steps, but users don't know the requirements for PRs and issues until much later on. It would be nice to have an explanation of these before the very end.

Steps to reproduce the problem

  1. Go to 'The Steps' section in First Steps on pages/vi/vi-first-steps.md

Screenshots

Here is the specific section:

Screen Shot 2019-10-23 at 6 09 04 PM

Proposed solution

Add a bulleted list or table describing the final requirements, while explaining that the requirements will be explained in detail in future steps. If using a table, I suggest making all the page's bulleted tables for consistency.

@animeshsingh75
Copy link
Contributor

In this I would suggest we could make the words as links starting from Mardown to Github PRs, so they can navigate as soon as the read it. It wouldn't require major changes as well

Kuljeet1998 pushed a commit to Kuljeet1998/Kuljeet1998.github.io that referenced this issue Jun 20, 2024
@AdhamElAsfar99
Copy link
Member

There is a small part at the end of Step 8 mentioning what should be completed by the end of the steps. I believe putting something similar at the beginning could be efficient and do the job. It won't take much time and keep it simple for now until a better method is done.

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

3 participants