0
/ 100
Strong community interest, but docs and engineering haven't caught up to the hype.
A modern, lightweight text editor with a minimalist design.
A low grade is a to-do list, not a judgment of your code
Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to A (93).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Add automated tests. They prove the code works and give contributors confidence to make changes.
- 2CI/CD14pt
Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
- 3CI/CD14pt
Add a lint step to catch style issues automatically.
- 4CI/CD14pt
Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
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
93
Contributing guide is detailed and thorough.
README documents how to install the project.
README is present.
Licensed under MIT.
Engineering
41
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
No dependency lockfile found (−70 pts).
→ Enable and commit packages.lock.json so NuGet restores are repeatable.
CI is configured (.github/workflows/main.yml).
.NET formatting configured (src/.editorconfig).
Issue or PR templates present.
Project health
95
Actively maintained (pushed within 3 months).
Dependency manifest found (src/Notepads.Controls/Notepads.Controls.csproj).
Repository has a description.
.gitignore present.
Repository files13 root entries
- .githubGood: CI is configured (.github/workflows/main.yml).Good: Dependabot covers 2 ecosystems (github-actions, nuget). Dependencies stay current.Good: Issue or PR templates present.
- ScreenShots
- srcGood: .NET formatting configured (src/.editorconfig).Good: Dependency manifest found (src/Notepads.Controls/Notepads.Controls.csproj).
- .gitattributes
- .gitignoreGood: .gitignore present.
- .whitesource
- azure-pipelines.yml
- CI-CD_DOCUMENTATION.md
- CODE_OF_CONDUCT.mdGood: Code of conduct present.
- 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.Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).Good: Contributing guide describes the PR/review workflow.Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
- LICENSE.txtGood: Licensed under MIT.
- PRIVACY.md
- README.mdGood: README is present.Good: README is well structured with multiple sections.Good: README includes screenshots or visuals. Great for first impressions.Good: README has code examples.Good: README links to a live demo or deployed app.Good: README includes status badges.Good: README documents how to install the project.Good: README documents how to run the project.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/0x7c13/notepads)