Skip to content

Add agents.md #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leowilkin merged 2 commits into from
Nov 26, 2025
Merged

Add agents.md #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b515a3
Add agents.md
leowilkin Oct 7, 2025
161d6ee
Merge branch 'main' of github.com:hackclub/submit
leowilkin Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Hack Club Submit – Agent Guide

## Commands
- **Dev**: `bin/dev` (runs Rails + Tailwind watcher with Foreman)
- **Test**: `bin/rails test` (run all tests) or `bin/rails test test/path/to/file_test.rb` (single test file)
- **Console**: `bin/rails console` (inspect data)
- **Database**: `bin/rails db:prepare` (setup), `bin/rails db:seed` (seed with superadmin)

## Architecture
- **Rails 7.1** app centered on OAuth with Hack Club Identity; entry point is `ProgramsController#show` (route: `/:program`)
- **Core controllers**: `IdentityController` (browser OAuth), `Api::VerifyController` (server verification), `Popup::AuthorizeController` (partner popup flow), `Admin::SessionsController` (admin login)
- **Key models**: `Program` (stores theming, scopes, mappings), `AuthorizedSubmitToken` (submit tokens), `AuthorizationRequest` (popup flow), `VerificationAttempt` (audit log), `AdminUser`, `UserJourneyEvent`
- **Services**: `StateToken` (OAuth state generation/validation), `IdentityNormalizer` (normalize identity payloads), `UserJourneyFlow` (journey helpers)
- **Database**: PostgreSQL; dev DB is `submit_ruby_development`, test DB is `submit_ruby_test`
- **Frontend**: Stimulus controllers in `app/javascript/controllers`, Tailwind via `tailwindcss-rails`, SVGs via `inline_svg` (store in `app/assets/images`)

## Conventions & Patterns
- **URL joining**: Use `ApplicationController#join_url`, never `File.join` for URLs
- **State tokens**: Generate with `StateToken.generate`, validate with `StateToken.verify`
- **Identity normalization**: Always call `IdentityNormalizer.normalize` before using identity payloads
- **Field filtering**: Respect `Program#allowed_identity_fields` when returning identity data (see `Api::VerifyController` for examples)
- **Token consumption**: Use `AuthorizedSubmitToken#consume!` to mark tokens used; reuse returns 410
- **Journey logging**: Log flow steps with `UserJourneyEvent.create! rescue nil` (pattern: `event_type='program_page'`)
- **Colors**: `Program` stores hex colors without `#`; callbacks downcase them automatically
- **Error handling**: Use `create_attempt_safely!` for `VerificationAttempt` to avoid unique constraint violations
- **External redirects**: Require `allow_other_host: true` (configured globally via `permit_other_host_redirects.rb`)