Adhere to established naming conventions for files, variables, functions, and configuration options to maintain consistency and clarity throughout the codebase and documentation.
README.md
instead of Readme.md
, LICENSE
without file extension)$HOME
or ~
throughout, don’t mix styles)__name__
) for regular functions to prevent confusion# Incorrect: Using dunder name for regular function
def __main__():
process_data()
# Correct: Use standard naming for regular functions
def main():
process_data()
In documentation, maintain consistent reference style:
# Inconsistent
- `$XDG_CACHE_HOME/uv` or `~/.cache/uv` on Unix systems
# Consistent
- `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Unix systems
Enter the URL of a public GitHub repository