Gitea/AGENTS.md at 4f363d27488e39766d9975761b2739dd2a67a9e9

mirror of https://github.com/go-gitea/gitea.git synced 2026-08-01 02:30:22 +00:00

Files

T

silverwind 7ac32c9b51 chore: tweak AGENTS.md (#38723 )

Further refinements to AGENTS.md:

- consolidate some points
- add point about locales
- rewrite some points for clarity and size

Signed-off-by: silverwind <me@silverwind.io>
Co-authored-by: delvh <dev.lh@web.de>

2026-07-31 13:12:30 +00:00

2.1 KiB

Raw Blame History

Never assume, verify before claiming
List development targets with make help
PR descriptions: minimal, only what and why, no task lists or file listings. Include screenshots for UI changes, before and after when modifying existing UI
Reference issues and PRs by full URL, not by number
Use Conventional Commits for commit messages and PR titles, plus Gitea's enhance type for user-facing enhancements
Add an Assisted-by: AGENT_NAME:MODEL_VERSION trailer to commit messages, never Co-Authored-By or Signed-off-by
Attribute agent authorship on one trailing line in issue and PR comments, never as a PR description section
Never rewrite git history unless asked, update PRs with new commits and normal push
Comments: write almost none, short and preferably same-line, explaining why for a future reader. Never narrate code, the change or the prompt. Preserve existing ones that still apply
Add the current year to copyright headers of new .go files
In options/locale, only edit locale_en-US.json, other locales are synced automatically
In TS, use ! instead of ?./?? when a value always exists
Prefer tw-* utilities over inline style and flex-* helpers over per-child tw-ml-*/tw-mr-* margins, falling back to tw-* where specificity requires !important
Run make fmt after .go edits, make tidy after go.mod edits, make generate-swagger after API changes, and lint what changed with make lint-go, lint-js, lint-css or lint-templates
Fix the cause rather than disabling a linter or weakening a test. Where unavoidable, use the narrowest scope with a trailing comment giving the reason
Run single tests with go test -run '^TestName$' ./modulepath/ for Go, pnpm exec vitest <path-filter> for TS and GITEA_TEST_E2E_FLAGS='<filepath>' make test-e2e for e2e
Write the fewest, fastest tests covering the behavior, extending an existing one where possible. Prefer unit tests where logic is testable in isolation
Aim for sub-2s per integration test and sub-4s per e2e test. Wait on a deterministic condition rather than sleep, and prefer semantic locators in e2e tests

2.1 KiB Raw Blame History

2.1 KiB

Raw Blame History