Skip to content

Commit fb834e6

Browse files
authored
docs: update agents file
1 parent 65e8324 commit fb834e6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

AGENTS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ This repository follows these guidelines for contributions by AI agents or human
1111

1212
2. **Simplicity First**: Prefer simpler implementations over overly complex solutions.
1313

14-
3. **Run Tests**: Always run tests before committing to ensure functionality and catch regressions. Use `go test ./...` for Go modules.
14+
3. **Run Tests**: Always run tests before committing to ensure functionality and catch regressions. Use `pytest --cov=whispr tests` for Python tests.
1515

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

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

20-
6. **Copyright Header**: Add the following header at the beginning of every new `.go` code file created as part of PR:
20+
6. **Copyright Header**: Add the following header at the beginning of every new `.py` code file created as part of PR:
2121

2222
```
2323
Copyright (c) 2025 Naren Yellavula & Cybrota contributors
@@ -30,6 +30,6 @@ you may not use this file except in compliance with the License.
3030

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

33-
9. **Style & Formatting**: Use opinionated formatters/lints (e.g. gofmt + goimports, golangci-lint) and run them.
33+
9. **Style & Formatting**: Use ruff linter to style the code.
3434

35-
10. **Security**: Run go vet, govulncheck to make sure code is free from basic security issues.
35+
10. **Security**: Run `bandit` to check if code is free from security issues

0 commit comments

Comments
 (0)