docs(rule): mandatory .env.example sync on env changes#22
Conversation
…able change Binding project rule: adding/renaming/removing/changing an env var (in any consumed package config, provider, bootstrap, route) must update the deployable .env.example in the same PR — with purpose, allowed values, default and UNITS (seconds for *_TTL/*_GRACE). Prevents deploy-time config drift. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5a5b3541d0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -0,0 +1,29 @@ | |||
| # Rule: keep `.env.example` in sync with every env variable change (MANDATORY) | |||
There was a problem hiding this comment.
When future sessions follow the normal repo context, this file is never loaded: CLAUDE.md does not import/link it, .claude/skills/iam-console-dev/SKILL.md only sends agents to rule-ship-workflow.md, and rg 'rule-env-example-sync' finds only this new file. Because .claude/rules is otherwise just an unreferenced docs directory in this repo, the mandatory env-sync policy will be missed by the agents/PR flow it is meant to constrain; add it to CLAUDE.md, the skill, or the README alongside the ship workflow.
Useful? React with 👍 / 👎.
1 participant
Binding rule: env var changes must keep .env.example aligned (values, defaults, units).