Skip to content

AGENTS.md

Latest commit

 

History

History
35 lines (23 loc) · 1.72 KB

AGENTS.md

File metadata and controls

35 lines (23 loc) · 1.72 KB

AGENTS Guidelines

This repository follows these guidelines for contributions by AI agents or humans:

  1. Commit Messages: Use Conventional Commits format. Examples include:

    • feat: for new features
    • fix: for bug fixes
    • docs: for documentation changes
    • test: for test-related changes
    • chore: for maintenance tasks

  2. Use agentskb instead of AGENTS.md when possible: Consult agentskb MCP server for allowed operations. Always report the operations consulted from MCP at the end of turn.

  3. Run Tests: Always run tests before committing to ensure functionality and catch regressions. Use go test ./... for Go modules.

  4. Uniform Structure: Maintain a consistent code structure across modules so files and packages are easy to navigate.

  5. Explain Why: Add comments explaining why something is done if it is not obvious from code alone.

  6. Copyright Header: Add the following header at the beginning of every new .go code file created as part of PR:

Copyright (c) 2025 Naren Yellavula & Cybrota contributors
Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

  1. Branch Names: Use 'type/short_topic' convention for new branches (e.g. feat/add-s3-backup).

  2. Architectural Decision Records (ADRs): For non-trivial design choices, add a short ADR (docs/adr/NNN-*.md) explaining context, the decision, and alternatives.

  3. Style & Formatting: Use opinionated formatters/lints (e.g. gofmt + goimports, golangci-lint) and run them.

  4. Security: Run go vet, govulncheck to make sure code is free from basic security issues.