coder / coder/backstage-plugins
Documentation: Add badges (e.g., code coverage) to the top-level README
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 67
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Split off from #34
Currently in the middle of fleshing out our tests, but once we have that in place, I think that we should be upfront as we can about the status of the project. Conveying things like code coverage and builds passing would go a long way towards giving people confidence in our offerings
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
Start with the top-level README and inspect the repository's existing test and build configuration to identify the status information available for badges. The work is done when the README shows relevant coverage and build-status badges that accurately reflect the project's current checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100