Skip to content

README.md

Latest commit

 

History

History
21 lines (16 loc) · 1.37 KB

README.md

File metadata and controls

21 lines (16 loc) · 1.37 KB
Raw

Contribute

For: Developers extending authserver — adding upstream providers, new grant types, transports, adapters; fixing bugs; shipping releases. Prereqs: Go 1.26.3+ (matches go.mod), Node.js 22+ (admin UI build only), Docker, golangci-lint v2.11+. See running-tests.md for the canonical matrix. Shared setup: make ci-local is the floor for "ready to push" — runs build, lint, import-boundary check, OSS-leak check, unit tests, govulncheck.

Reading order

  1. Repo tour — what lives where.
  2. Hexagonal layers — where to put your code.
  3. Coding conventions — names, errors, factory patterns.
  4. Add an upstream provider — the most common extension.
  5. Add a grant type — the next most common extension.
  6. Running tests — unit, integration, e2e, docs-smoke.
  7. Release process — tagging, goreleaser, Helm bump.

Conventions used in this section

  • Code paths cite package/file.go:LINE references against current develop.
  • Every recipe ends with a "Verify" checklist mirroring make ci-local plus the recipe-specific assertions.
  • The repo's full agent-facing protocol lives in AGENTS.md. This section is the human-readable summary for contributors.