crys-chen/ic-guide

0

/ 100

Documentation63
Engineering42
Health100
Python82Other1d ago
Grade a repo

Getting some notice. Tests and CI would be the fastest wins.

集成电路 / 微电子专业自学指南。17 个科研方向全景导览（课题组 · 知识路径 · 毕业去向），7大知识板块 200+ 门课程资源，帮助同学们构建连续的知识体系。希望对同学们的学习有所帮助❤️，如果喜欢请给个star🌟

Documentation

63

Contributing guide5pt0

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.

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

README12pt85

README is present.

License6pt100

Licensed under Other.

Engineering

42

Tests18pt0

No tests detected anywhere in the repository.

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

CI/CD14pt40

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

Reproducibility6pt70

Lockfile present (requirements.txt). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

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)
  • 7
    Forks
  • 13
    Releaseslatest 12d ago

Community

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

Responsiveness

  • 2h
    Median issue response
  • 3h
    Median PR merge time
  • 0
    Open issues
Repository files12 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Issue or PR templates present.
  • docs
  • overrides
  • scripts
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • hooks.py
  • LICENSE
    Good: Licensed under Other.
  • mkdocs.yml
  • 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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).