smithy-lang/smithy-swift

0

/ 100

Documentation70
Engineering82
Health84
Smithy40Apache-2.01d ago
Grade a repo

Solid foundation. Invest in docs and CI to grow from here.

Documentation

70

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt66

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

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

README12pt75

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

82

Reproducibility6pt12

No dependency lockfile found (−70 pts).

→ Commit Package.resolved for application projects so Swift Package Manager resolves the same versions.

Tests18pt80

Test files detected (Tests).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (.swiftlint.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

84

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt100

Dependency manifest found (Package.swift).

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)
  • 33
    Forks
  • 251
    Releaseslatest 4y ago

Community

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

Responsiveness

  • 6d 20h
    Median issue response
  • 1d 2h
    Median PR merge time
  • 10
    Open issues
Repository files26 root entries
  • .github
    Good: CI is configured (.github/workflows/lint.yml).
    Good: Dependabot configured for swift.
    Good: Issue or PR templates present.
  • .swiftpm
  • buildSrc
  • design
  • gradle
  • Plugins
  • scripts
  • serde-benchmark
  • smithy-swift-codegen
  • Sources
  • test-sdks
  • Tests
    Good: Test files detected (Tests).
  • .gitignore
    Good: .gitignore present.
  • .swiftlint.yml
    Good: Linter or formatter configured (.swiftlint.yml).
  • build.gradle.kts
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +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.
    Good: Contributing guide includes code examples.
  • gradle.properties
  • gradlew
  • gradlew.bat
  • LICENSE
    Good: Licensed under Apache-2.0.
  • NOTICE
  • Package.swift
    Good: Dependency manifest found (Package.swift).
  • Package.version
  • Package.version.next
  • 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.
    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.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • settings.gradle.kts