Skip to content

Commit 65e8324

Browse files
authored
docs: add agents file
1 parent dc1184e commit 65e8324

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

AGENTS.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# AGENTS Guidelines
2+
3+
This repository follows these guidelines for contributions by AI agents or humans:
4+
5+
1. **Commit Messages**: Use [Conventional Commits](https://www.conventionalcommits.org/) format. Examples include:
6+
- `feat:` for new features
7+
- `fix:` for bug fixes
8+
- `docs:` for documentation changes
9+
- `test:` for test-related changes
10+
- `chore:` for maintenance tasks
11+
12+
2. **Simplicity First**: Prefer simpler implementations over overly complex solutions.
13+
14+
3. **Run Tests**: Always run tests before committing to ensure functionality and catch regressions. Use `go test ./...` for Go modules.
15+
16+
4. **Uniform Structure**: Maintain a consistent code structure across modules so files and packages are easy to navigate.
17+
18+
5. **Explain Why**: Add comments explaining *why* something is done if it is not obvious from code alone.
19+
20+
6. **Copyright Header**: Add the following header at the beginning of every new `.go` code file created as part of PR:
21+
22+
```
23+
Copyright (c) 2025 Naren Yellavula & Cybrota contributors
24+
Apache License, Version 2.0
25+
26+
Licensed under the Apache License, Version 2.0 (the "License");
27+
you may not use this file except in compliance with the License.
28+
```
29+
7. **Branch Names**: Use '_type_/_short_topic_' convention for new branches (e.g. feat/add-s3-backup).
30+
31+
8. **Architectural Decision Records (ADRs)**: For non-trivial design choices, add a short ADR (docs/adr/NNN-*.md) explaining context, the decision, and alternatives.
32+
33+
9. **Style & Formatting**: Use opinionated formatters/lints (e.g. gofmt + goimports, golangci-lint) and run them.
34+
35+
10. **Security**: Run go vet, govulncheck to make sure code is free from basic security issues.

0 commit comments

Comments
 (0)