Skip to main content

​
AGENTS.md

Guidelines for AI agents working with the Nonce documentation site.

​
Git Commit Convention

Follow the Conventional Commits specification: 
type(scope): short description

- actual code change 1
- actual code change 2
- actual code change 3
Rules:
  • Use semantic commit format: type(scope): description
  • type: feat, fix, refactor, perf, docs, style, test, chore, etc.
  • scope: the module or component being modified
  • description: concise, lowercase, no trailing period
  • body: concise list describing only the actual code changes
  • The entire commit message (title + body) must be in English
  • Do not include: contextual explanations, background information, review feedback references, effect descriptions, or rationale
  • Do not add Co-Authored-By trailers
Good example: 
refactor(miner_performance): split pool status update into independent asset

- create miner_pool_status_update asset
- remove pool update logic from miner_performance_aggregation
- add independent hourly job and schedule
Bad example: 
refactor(miner_performance): split pool status update into independent asset

Address review feedback from @infilos: this change improves performance
by separating concerns. With 300k miners at scale, this optimization
becomes more significant.

Co-Authored-By: Claude <noreply@anthropic.com>

​
Pull Request Convention

  • PR body must follow the format defined in .github/PULL_REQUEST_TEMPLATE.md
  • Changes list items: lowercase, conventional commit style (e.g., “add xxx”, “replace xxx”, “remove xxx”). Describe what was done — do not reference specific code locations or implementation details
  • Related Linear Issues: remove unused entries entirely; do not leave empty checkboxes
  • Apply at least one label when creating a PR using --label: bugfix, feature, enhancement, or other applicable labels