Hey Everyone!
I will be mentioning my ideas here for the documentation task force.
Initial Ideas :
GitHub templates and best practices :
- Creating a standard pull request template for the GitHub repository.
- Using automation for closing the issue and PR.
- Mentioning coding guidelines
Project templates and best practices :
A standard documentation template for all projects should be there. The template should include the following:
- Purpose of the project so that users can understand what the project is about, enhancing user experience.
- Describe how to use the project, functionalities of various features, relevant links, code snippets, algorithms, images, graphics, flow charts, user flow, etc.
- Feedback from users
- Conclusion and people to contact for more information (maintainers, project mentor)
Resources:
(https://github.com/devspace/awesome-github-templates)[GitHub Templates]