zigcc/zig-course

0

/ 100

Documentation91
Engineering56
Health100
Zig360MIT1d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

Zig 语言圣经：简单、快速地学习 Zig, Zig Chinese tutorial, learn zig simply and quickly

Documentation

91

Contributing guide5pt60

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

56

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.

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.

CI/CD14pt57

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

Tests18pt80

Test files detected (course/code/12/build_system/test).

Reproducibility6pt82

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

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

  • —
    Commits (30d / 90d)
  • 49
    Forks
  • 14
    Releaseslatest 8mo ago

Community

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

Responsiveness

  • 13h
    Median issue response
  • <1h
    Median PR merge time
  • 3
    Open issues
Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot configured for bun.
  • assets
  • build
  • course
    Good: Test files detected (course/code/12/build_system/test).
  • draw
  • scripts
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • AGENTS.md
  • build.zig
  • bun.lock
    Good: Lockfile present (bun.lock). Installs are reproducible.
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    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
    Good: Licensed under MIT.
  • package.json
    Good: Dependency manifest found (package.json).
  • prettierrc.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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.