diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-14 22:12:24 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-14 22:12:24 +0300 |
| commit | 5c82623dbf6097035332f14164269ecaede6a61d (patch) | |
| tree | 309eb989be54ceb92c5878d8f3d13ed6637f6df3 /AGENTS.md | |
| parent | 50d608bbd62949f6b6ed5fa2827718248f070021 (diff) | |
docs: add prerelease docs guardrails
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 1 |
1 files changed, 1 insertions, 0 deletions
@@ -52,6 +52,7 @@ Unit tests live next to the code (`#[cfg(test)] mod tests`). If you add behavior - Conventional commits, lowercase, no emojis. - Do not edit `CHANGELOG.md` during normal feature or fix work. Changelog entries are drafted and applied immediately before release. +- Do not advertise unreleased features in public docs before the release is cut. Keep README, `CONFIGURATION.md`, `INTEGRATIONS.md`, `SOCKET_API.md`, website copy, and config examples aligned with the latest published release unless the user explicitly asks for prerelease docs. - Put local PRDs, planning notes, and exploratory specs under `.prd/`; that directory is ignored and locally controlled. - When a commit fully fixes a GitHub issue, include `fixes #<issue-number>` in the commit body so GitHub closes it on merge. - Rust: no `unwrap()` in production code. `tracing` for logging. `#[allow]` only with a comment explaining why. |