87
/ 100
Polished and well engineered. Punching above its star count.
Documentation for CircleCI.
Top fixes
Highest-impact changes first, ranked by point weight
- 1README12pt
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
- 2README12pt
Add CI/build status badges from shields.io or your CI provider to signal project health.
- 3Install and run instructions9pt
Add a .env.example listing all required environment variables so contributors know what to set up.
- 4License6pt
Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
Working through the fixes? Let every push regrade itself.
The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
65
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
README is present.
Contributing guide is detailed and thorough.
README documents how to install the project.
Engineering
98
Lockfile present (go.sum). Installs are reproducible.
Test files detected (docs/guides/modules/ROOT/images/test).
CI is configured (.circleci/config.yml).
Formatting enforced (ui/.stylelintrc).
Issue or PR templates present.
Project health
94
.gitignore present.
Dependency manifest found (go.mod).
Repository has a description.
Actively maintained (pushed within the last month).
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- 79 / 720Commits (30d / 90d)
- 1,496Forks
- 0Releases
Community
- 50% - FairCommunity health
- 2 bus factorauthors own >50% of commits
- 849Watchers
Responsiveness
- 2d 21hMedian issue response
- <1hMedian PR merge time
- 38Open issues
Repository files43 root entries
- .circleciGood: CI is configured (.circleci/config.yml).
- .cursor
- .githubGood: Issue or PR templates present.
- api-v1
- archive
- cmd
- docsGood: Test files detected (docs/guides/modules/ROOT/images/test).Issue: Build artifacts or local files may be committed (docs/guides/.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
- extensions
- gulp.d
- internal
- planning
- scripts
- skills
- styles
- uiGood: Formatting enforced (ui/.stylelintrc).
- .env.copy
- .gitignoreGood: .gitignore present.
- .htmltest.yml
- .nvmrcGood: Environment pinned via .nvmrc.
- .vale.ini
- agent-docs.config.yml
- AGENTS.md
- antora-playbook.yml
- API_DOCS_INTEGRATION.md
- API_DOCS_LLM_ACCESS_PLAN.md
- ARCHITECTURE.md
- CLAUDE.md
- CONTENT_AUTHORING.md
- CONTRIBUTING.mdGood: Contributing guide is detailed and thorough.Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.Good: Contributing guide describes code style expectations.Good: Contributing guide explains how to run tests.Good: Contributing guide describes the PR/review workflow.Good: Contributing guide includes code examples.
- custom-template.hbs
- DEVELOPMENT.md
- go.modGood: Dependency manifest found (go.mod).
- go.sumGood: Lockfile present (go.sum). Installs are reproducible.
- gulpfile.js
- logo.svg
- openapi-patch.json
- package-lock.json
- package.json
- README.mdGood: README is present.Good: README is well structured with multiple sections.Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.Good: README has code examples.Good: README links to a live demo or deployed app.Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.Good: README documents how to install the project.Good: README documents how to run the project.
- redocly.yaml
- renovate.json
- Taskfile.yml
- TECHNICAL_REFERENCE.md
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/circleci/circleci-docs)