0x7c13/notepads

0

/ 100

Documentation93
Engineering41
Health95
C#10,135MIT2mo ago
Grade a repo

Strong community interest, but docs and engineering haven't caught up to the hype.

A modern, lightweight text editor with a minimalist design.

Documentation

93

Contributing guide5pt72

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

41

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

Reproducibility6pt20

No dependency lockfile found (−70 pts).

→ Enable and commit packages.lock.json so NuGet restores are repeatable.

CI/CD14pt57

CI is configured (.github/workflows/main.yml).

Linting and formatting5pt100

.NET formatting configured (src/.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

95

Activity5pt80

Actively maintained (pushed within 3 months).

Dependency manifest6pt100

Dependency manifest found (src/Notepads.Controls/Notepads.Controls.csproj).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files13 root entries
  • .github
    Good: 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
  • src
    Good: .NET formatting configured (src/.editorconfig).
    Good: Dependency manifest found (src/Notepads.Controls/Notepads.Controls.csproj).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .whitesource
  • azure-pipelines.yml
  • CI-CD_DOCUMENTATION.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: 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.txt
    Good: Licensed under MIT.
  • PRIVACY.md
  • README.md
    Good: 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.