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:
mcpServers
instead of servers
to include contextstoreResponses
over store
to clarify the parameter’s purposeUpdateState
instead of generic State
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.
Enter the URL of a public GitHub repository