Skip to content

Add AGENTS.md #10

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
tamalsaha merged 1 commit into from
May 18, 2026
Merged

Add AGENTS.md #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 32 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# AGENTS.md

This file provides guidance to coding agents (e.g. Claude Code, claude.ai/code) when working with code in this repository.

## Repository purpose

The AppsCode fork of [decke/smtprelay](https://github.com/decke/smtprelay) — a small Go-based SMTP relay/proxy that accepts mail via SMTP and forwards it to another SMTP server. Used by AppsCode platform services to centralize outbound mail.

Module path is `go.bytebuilders.dev/smtprelay` (AppsCode-renamed). Git remote is `appscode-cloud/smtprelay`. Tracks upstream `decke/smtprelay`.

## Architecture

- Top-level Go files: `config.go`, `auth.go` (and tests). The SMTP server proper.
- `cmd/` — entry point.
- `Dockerfile.in` (PROD, distroless), `Dockerfile.dbg` (debian), `Dockerfile.ubi` (Red Hat certified).
- `hack/`, `Makefile` — AppsCode build harness.

## Common commands

- `make ci` — full CI pipeline.
- `make build` / `make all-build` — host or all-platform build.
- `make fmt`, `make lint`, `make unit-tests` / `make test` — standard.
- `make verify` — codegen + module-tidy verification.
- `make container` / `make push` / `make release` — image build/publish flow.

## Conventions

- Module path is `go.bytebuilders.dev/smtprelay`; imports must use that. Upstream is `github.com/decke/smtprelay` — keep AppsCode patches isolated.
- License: see `LICENSE` (matches upstream).
- Sign off commits (`git commit -s`).
- Single-purpose SMTP relay. Resist scope creep — adjacent functionality (templates, auth-token gen) belongs in `email-templates` / `smtprelay-auth-generator`.
- Three Dockerfiles, one binary — keep `Dockerfile.in`, `Dockerfile.dbg`, and `Dockerfile.ubi` in sync.
Loading