mirror of
https://gitea.com/gitea/act_runner.git
synced 2026-08-06 00:44:22 +02:00
Carries over the applicable rules from https://gitea.com/gitea/gitea `AGENTS.md`, including the Conventional Commits and `make lint-go-windows` requirements this repo already enforces but never documented for agents. Swaps `Co-Authored-By` for the `Assisted-by` trailer. Reviewed-on: https://gitea.com/gitea/runner/pulls/1134 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: silverwind <me@silverwind.io>
1.8 KiB
1.8 KiB
- Never assume, verify before claiming
- Use
make helpto find available development targets - PR descriptions: minimal, only what and why, no task lists or file listings
- Reference issues and PRs by full URL, not by number
- Use Conventional Commits for commit messages and PR titles, plus the
enhancetype for user-facing enhancements - Add an
Assisted-by: AGENT_NAME:MODEL_VERSIONtrailer to commit messages, neverCo-Authored-ByorSigned-off-by - Attribute agent authorship on one trailing line in issue and pull request comments, never as a PR description section
- Never force-push, amend, or squash unless asked. Use new commits and normal push for pull request updates
- 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 into the copyright header of new
.gofiles - Ensure no trailing whitespace in edited files
- Run
make fmtafter.goedits,make tidyaftergo.modedits, andmake checksfor the non-lint source checks - Lint what changed with
make lint-go, andmake lint-go-windowsfor Windows and platform-split files - 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 go tests with
go test -run '^TestName$' ./modulepath/.make testself-skips the integration tests without docker or network,make test-dindruns the daemon-facing tests against the built dind image - Write the fewest, fastest tests covering the behavior, extending an existing one where possible. Prefer unit tests where logic is testable in isolation
- Wait on a deterministic condition rather than
sleep - Update the files under
docs/when behavior documented there changes