OpenEnergyPlatform / OpenEnergyPlatform/organisation
Include badges in the documentation
Open
@Ludee is already working on this.
Since Dec 2, 2021.
documentation
enhancement
help wanted
- Dominant language
- CSS
- Stars
- 10
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
This repository could benefit from displaying badges to signal the standard of the code to other developers and improve the quality of the repository's documentation.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
The issue names no files, tests, or documentation entry point. Start by locating the repository's documentation and checking existing badge conventions, then confirm which badges and placement are wanted with maintainers. The work is done when the agreed badges are displayed in the documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100