mirror of
https://github.com/gravitational/teleport.git
synced 2026-10-12 02:15:01 +00:00
rosstimothy
7309862f42
RFD 153 is often not followed, and only caught after the fact. In an effort to catch deviations sooner than later, AGENTS.md was updated in an attempt to get the review bot to catch these deviations.
1.1 KiB
1.1 KiB
AGENTS.md
Review Guidelines
- Focus only on critical security, reliability, performance, and scalability issues.
- Ignore style, performance micro-optimizations, and readability nits unless they are tied to a significant failure
What to Look For
- Authentication/authorization bypasses
- Secret leakage, unsafe logging, or credential exposure
- Unsafe defaults in security-sensitive areas
- Injection risks (SQL, command, template, path traversal, SSRF)
- Insecure crypto usage or key handling
- Privilege escalation or sandbox escapes
- Data corruption, durability failures, or irreversible loss scenarios
- Concurrency hazards that can cause outages or data races
- Reliability regressions: crash loops, panics, deadlocks, unbounded retries, nil pointer dereferences
- Adherence to the guidelines defined in RFD 153 of Teleport resource definitations, gRPC, backend storage, and cache APIs.
Documentation
When you are looking at a given product area find the relevant documentation in the docs/ directory to ensure you understand the context in which the code is used.