DevRel project README template
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 221
- Forks
- 174
- PR merge metrics
- No merged PRs in 30d
Description
We have some concerns that some of the README content are missing some sections which might be helpful when/if you would like to use them in demos. Installation is generally not a problem (due to pipeline), but once you install one of the more complicated projects, it is sometimes difficult to understand what features and functionalities have been implemented and the best way to demo them to others.
In order to solve this problem and also to put some structure to the READMEs, it is proposed that we create a template to guarantee consistent information in our READMEs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.