domains / / openai/codex
Prefer specific identifiers
Always use specific, descriptive names for identifiers rather than generic terms. Names should clearly indicate their purpose and context, making code more readable and self-documenting. This applies to variables, parameters, types, and files.
Always use specific, descriptive names for identifiers rather than generic terms. Names should clearly indicate their purpose and context, making code more readable and self-documenting. This applies to variables, parameters, types, and files.
Examples:
- Use
mcpServersinstead ofserversto include context - Prefer
storeResponsesoverstoreto clarify the parameter’s purpose - Name types specifically like
UpdateStateinstead of genericState - Use file names that reflect content purpose (e.g.,
update-state.json,.codex.env)
This practice reduces cognitive load for other developers, improves maintainability, and helps prevent confusion or misuse of code elements. The additional verbosity is well worth the clarity it provides.