royalfire5/brackets

0

/ 100

Documentation87
Engineering76
Health49
0MIT5y ago
Grade a repo

Solid engineering. The main gap is visibility.

An open source code editor for the web, written in JavaScript, HTML and CSS.

Documentation

87

Contributing guide5pt72

Contributing guide is detailed and thorough.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

76

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit package-lock.json, pnpm-lock.yaml, yarn.lock, or bun.lock so Node installs are repeatable.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Tests18pt100

Test files detected (src/extensibility/node/spec).

CI/CD14pt100

CI is configured (.travis.yml).

Linting and formatting5pt100

Linter or formatter configured (.eslintrc.js).

Project health

49

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

→ A recent commit signals the project is alive and worth using.

Repository metadata5pt60

Repository has a description.

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt72

Dependency manifest found (package.json).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 0
    Watchers

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files23 root entries
  • samples
  • src
    Good: Test files detected (src/extensibility/node/spec).
    Issue: Build artifacts or local files may be committed (src/extensions/default/StaticServer/node/node_modules/connect) (−40 pts).Fix: Remove them and add to .gitignore.
  • tasks
  • test
  • tools
  • .brackets.json
  • .eslintignore
  • .eslintrc.js
    Good: Linter or formatter configured (.eslintrc.js).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .npmrc
  • .travis.yml
    Good: CI is configured (.travis.yml).
  • build.json
  • 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.
  • Gruntfile.js
  • ISSUE_TEMPLATE.md
  • LICENSE
    Good: Licensed under MIT.
  • NOTICE
  • npm-shrinkwrap.json
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    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.