[Feature] Setup guides
directory with accompanying README.md
explainer
#110
Labels
💻 aspect: code
Concerns the software code in the repository
🤖 aspect: dx
Concerns developers' experience with the codebase
✨ goal: improvement
Improvement to an existing feature
🟩 priority: low
Low priority and doesn't need to be rushed
🏁 status: ready for work
Ready for work
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.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 explainerREADME.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:
Setting up Docker on Linux
,Setting up Docker on Windows
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.
Implementation
The text was updated successfully, but these errors were encountered: