There are instances where newcomers/beginners would benefit from more specific and detailed instructions related to this project than what is present in the standard README.md, but expanding the README.md file to accommodate this could make it bloated and confusing.
Description
To resolve this we're going to add a /guides directory with an explainer README.md file within it, and allow this folder to contain various guides for this repository, as relevant to newcomers and beginners.
Some examples might include:
How to create new Actions workflows
Understanding the importance of Semantics
Guides can include detailed instructions and/or relevant links to resources on the web, such as tutorials, dev guides, etc. to help people better understand how to contribute to this project as a beginner.
Problem
There are instances where newcomers/beginners would benefit from more specific and detailed instructions related to this project than what is present in the standard
README.md, but expanding theREADME.mdfile to accommodate this could make it bloated and confusing.Description
To resolve this we're going to add a
/guidesdirectory with an explainerREADME.mdfile within it, and allow this folder to contain various guides for this repository, as relevant to newcomers and beginners.Some examples might include:
Guides can include detailed instructions and/or relevant links to resources on the web, such as tutorials, dev guides, etc. to help people better understand how to contribute to this project as a beginner.
Additional context
Implementation