Skip to content

Introduce a Code Formatter #5

@CameronNicolson

Description

@CameronNicolson

Introduce a Code Formatter

Implementing a code formatter ensures that our code remains tidy, adheres to consistent styling rules, and is easier to read across different environments.

Why is this needed?

When the code is opened on different machines, it should remain readable, approachable, and consistent. A formatter helps enforce a unified style, making collaboration smoother and reducing unnecessary formatting changes in commits.

Any Considerations?
At the time of writing, Black is a well-known and widely used Python formatter for this purpose. However, we should consider its adherence to our project's style and whether its formatting rules align with our needs. If necessary, we can explore alternative tools or configurations that better fit our codebase.

Metadata

Metadata

Assignees

No one assigned

    Labels

    EnhancementNew feature or request

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions