Skip to content

AGENTS.md

Latest commit

 

History

History
47 lines (34 loc) · 3.14 KB

AGENTS.md

File metadata and controls

47 lines (34 loc) · 3.14 KB

Project Overview

Thunder is a lightweight user and identity management product. Go backend + React frontend in a monorepo. It provides authentication and authorization via OAuth2/OIDC, flexible orchestration flows, and individual auth mechanisms (password, passwordless, social login).

Thunder's login gate leverages v2 of the Asgardeo JavaScript SDK, consumed via its published package in typical setups. Clone the SDK repository only if you are developing or debugging the SDK itself, or testing Thunder against unreleased SDK changes.

General Rules

  • Keep changes minimal and focused on the task requested. Do not refactor, "improve", or clean up surrounding code.
  • Do not add comments, docstrings, or type annotations to code you did not change.
  • Prefer editing existing files over creating new ones.
  • Do not add new dependencies or modify CI/CD pipelines, GitHub Actions, or Makefiles without explicit approval.
  • Do not over-engineer. No premature abstractions, no feature flags, no backwards-compatibility shims.
  • Mocks are auto-generated via make mockery. Do not generate or modify mock files manually.
  • Delete dead code cleanly. No // removed or // deprecated placeholder comments. No renaming unused variables to _ prefixed names — remove them entirely unless required by an interface, callback, or framework signature.
  • Do not create fallback tests with mock/hardcoded data when original tests fail. Fix the actual failing tests.
  • Do not add error handling for scenarios that cannot happen.
  • Write tests for new features and bug fixes (target 80%+ coverage).
  • Ensure proper error handling and logging at appropriate layers — not everywhere, just where failures are expected and actionable.
  • Ensure all identity-related code aligns with relevant RFC specifications.
  • Use make lint and make test to verify code quality and correctness before committing.

Git and PR Conventions

  • Adhere to .github/pull_request_template.md

Commit Messages

  • Use short imperative sentences without conventional commit prefixes (no feat:, fix:, etc.).
  • Reference the related issue or pull request when applicable (e.g., Refs #123 or Fixes #123).

One Commit Per Pull Request

  • PRs are squash-merged, so the final commit history stays clean automatically.

Agent Skills

  • Thunder Console Navigator — Browse and interact with the Thunder Console UI using playwright-cli. Use when asked to navigate the console, test UI changes, or create/edit resources through the browser.

Contributing Guidelines