open-learning-exchange.github.io icon indicating copy to clipboard operation
open-learning-exchange.github.io copied to clipboard

Add PR and issue requirements in 'The Steps' section

Open jholtkort opened this issue 6 years ago • 2 comments

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.

jholtkort avatar Oct 23 '19 23:10 jholtkort

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

animeshsingh75 avatar May 08 '24 05:05 animeshsingh75

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.

AdhamElAsfar99 avatar Jul 14 '24 01:07 AdhamElAsfar99