seeed-studio/wiki-documents

0

/ 100

Documentation63
Engineering37
Health100
JavaScript335GPL-3.0today
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

https://wiki.seeedstudio.com Seeed Studio Wiki source code

Documentation

63

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

Contributing guide5pt67

Contributing guide is detailed and thorough.

README12pt90

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

37

Tests18pt0

No tests detected anywhere in the repository.

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

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

CI/CD14pt57

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

Reproducibility6pt70

Lockfile present (yarn.lock). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • 739 / 2286
    Commits (30d / 90d)
  • 287
    Forks
  • 0
    Releases

Community

  • 87% - Good
    Community health
  • 3 bus factor
    authors own >50% of commits
  • 335
    Watchers

Responsiveness

  • 12d 21h
    Median issue response
  • <1h
    Median PR merge time
  • 67
    Open issues
Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/Check_PR_Update.yml).
    Good: Issue or PR templates present.
  • assets
  • blog
  • scripts
  • sites
  • src
  • static
  • .gitignore
    Good: .gitignore present.
  • .markdownlint.json
  • 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.
  • docsearch.json
  • docusaurus.config.js
  • HOW_TO.md
  • LICENSE
    Good: Licensed under GPL-3.0.
  • 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.
    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.
    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.
  • SECURITY.md
    Good: Security policy present.
  • tsconfig.json
  • yarn.lock
    Good: Lockfile present (yarn.lock). Installs are reproducible.