Popular for its size, but the engineering basics lag behind the interest.
This is a mirror from https://gerrit.wikimedia.org/g/mediawiki/services/parsoid/. See https://www.mediawiki.org/wiki/Developer_access for contributing.
Documentation
31
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).
→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.
README is present.
Licensed under GPL-2.0.
Engineering
48
No CI configuration detected in this repository.
→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
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.
Lockfile present (package-lock.json). Installs are reproducible.
Test files detected (bin/domdiff.test.js).
PHP linting configured (.editorconfig).
Project health
100
Dependency manifest found (composer.json).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 67Forks
- 0Releases
Community
- —Community health
- —authors own >50% of commits
- 185Watchers
Responsiveness
- —Median issue response
- —Median PR merge time
- 0Open issues
Repository files29 root entries
- .phan
- baseconfig
- binGood: Test files detected (bin/domdiff.test.js).
- docs
- extension
- lib
- src
- tests
- tools
- .editorconfigGood: PHP linting configured (.editorconfig).
- .eslintignore
- .eslintrc.json
- .gitattributes
- .gitignoreGood: .gitignore present.
- .gitreview
- .mailmap
- .phpcs.xml
- CODE_OF_CONDUCT.mdGood: Code of conduct present.
- composer.jsonGood: Dependency manifest found (composer.json).
- COPYING.txt
- core-upgrade.js
- Doxyfile
- extension.json
- HISTORY.md
- package-lock.jsonGood: Lockfile present (package-lock.json). Installs are reproducible.
- package.json
- phpunit.xml.dist
- quibble.yaml
- README.mdGood: README is present.Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.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.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.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.Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.