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

[Feature] Setup guides directory with accompanying README.md explainer #110

Closed
1 task done
possumbilities opened this issue Oct 18, 2022 · 5 comments · Fixed by #113
Closed
1 task done

[Feature] Setup guides directory with accompanying README.md explainer #110

possumbilities opened this issue Oct 18, 2022 · 5 comments · Fixed by #113
Assignees
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

Comments

@possumbilities
Copy link
Contributor

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 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:

  • Specific operating system steps like Setting up Docker on Linux, Setting up Docker on Windows
  • Specific resolution paths for known issues with different setups for this project.

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

  • I would be interested in implementing this feature.
@possumbilities possumbilities added 🟩 priority: low Low priority and doesn't need to be rushed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase labels Oct 18, 2022
@possumbilities possumbilities self-assigned this Oct 18, 2022
@TimidRobot
Copy link
Member

TimidRobot commented Oct 18, 2022

For guide filenames, I recommend snake_case (Snake case - Wikipedia)

@ImaJin14
Copy link
Contributor

@possumbilities I'll be happy to document this once it's status changes to ready for work:)

Please assign it to me...

@dikehprosper
Copy link
Contributor

i would be happy to work on this too ..... @ImaJin14 can we work together on this?

@possumbilities
Copy link
Contributor Author

@dikehprosper @ImaJin14 Thank you both for your excitement, but I'm already working on it, indicated by the checkbox being selected of I would be interested in implementing this feature, and that it's currently assigned to me.

@Vanessa082
Copy link

Hey @possumbilities I see this issue is open interested in working on it but I have some questions for clarification when you say a guide directory you mean the path right did not see anything like that in the project repo also is this related to the contribution.md file and the contribution page

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants