luzifer/nginx-sso

0

/ 100

Documentation45
Engineering82
Health100
Go303Apache-2.01d ago
Grade a repo

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

SSO authentication provider for the auth_request nginx module

Documentation

45

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

README12pt48

README is present.

Contributing guide5pt52

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.

License6pt100

Licensed under Apache-2.0.

Engineering

82

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/CD14pt85

CI is configured (.github/workflows/test-and-build.yml).

Reproducibility6pt85

Lockfile present (go.sum). Installs are reproducible.

Tests18pt100

Test files detected (acl_test.go).

Linting and formatting5pt100

Formatting enforced (gofmt (built into Go toolchain)).

Project health

100

Dependency manifest6pt100

Dependency manifest found (go.mod).

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)
  • 41
    Forks
  • 47
    Releaseslatest 7y ago

Community

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

Responsiveness

  • 4h
    Median issue response
  • 7h
    Median PR merge time
  • 13
    Open issues
Repository files28 root entries
  • .forgejo
  • .github
    Good: CI is configured (.github/workflows/test-and-build.yml).
  • frontend
  • plugins
  • .gitignore
    Good: .gitignore present.
  • acl_test.go
    Good: Test files detected (acl_test.go).
  • acl.go
  • audit.go
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • config.yaml
  • 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).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • core.go
  • docker-start.sh
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • History.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • main.go
  • Makefile
  • mfa.go
  • plugins.go
  • pongo.go
  • README.md
    Good: 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 some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.
    Good: README includes status badges.
    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.
  • redirect_test.go
  • redirect.go
  • registry.go
  • renovate.json