Files
Gogs/AGENTS.md
Joe Chen ed6109d35d chore: update AGENTS.md
[skip ci]
2026-01-30 22:01:02 -05:00

1.8 KiB

Core principles

  • When you see changes made outside your knowledge, use the current version as your new starting point. Do not blindly overwrite those changes or you suck. Even if you have to update the code, always respect the pattern in the surrounding context!
  • Do not tell me I am right, do it right on your first try, fact-check and review after changes. If you are not sure, ask for help.

Style and mechanics

This applies to all texts, including but not limited to UI, documentation, code comments.

  • Use sentence case. Preserve original casing for brand names.
  • End with a period for a full sentence.
  • Do not add comments that repeat what the code is doing, always prefer more descriptive names. Do add comments for intentions that aren't obvious via reading the code alone. This rule takes precedence over matching existing patterns.

Coding guidelines

  • Use github.com/cockroachdb/errors for error handling.
  • Use github.com/stretchr/testify for assertions in tests. Be mindful about the choice of require and assert, the former should be used when the test cannot proceed meaningfully after a failed assertion.

Build instructions

  • Prefer task command over vanilla go command when available. Use --force flag when necessary.
  • Run task lint after every time you finish changing code, and fix all linter errors.

Tool-use guidance

  • Use gh CLI to access information on github.com that is not publicly available.

Source code control

  • When pushing changes to a pull request from a fork, use SSH address and do not add remote.
  • Never automatically executes commands that touches Git history even if the session does not require approvals, including but not limited to rebase, commit, push, pull. One-time execution is only allowed when being explicitly asked to do so.