From 5c82623dbf6097035332f14164269ecaede6a61d Mon Sep 17 00:00:00 2001 From: Ogulcan Celik Date: Thu, 14 May 2026 22:12:24 +0300 Subject: docs: add prerelease docs guardrails --- AGENTS.md | 1 + 1 file changed, 1 insertion(+) (limited to 'AGENTS.md') diff --git a/AGENTS.md b/AGENTS.md index 769da1d0..4c7499ab 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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 #` 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. -- cgit v1.2.3