Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Ruff as code formatter #9

Open
j-emberton opened this issue Feb 3, 2025 · 0 comments
Open

Add Ruff as code formatter #9

j-emberton opened this issue Feb 3, 2025 · 0 comments

Comments

@j-emberton
Copy link

This issue is a proposal to add Ruff as a code formatter for this repository. This will help ensure that all developers work to the code set of code standards.

Ruff will be added as a pre-commit git hook. This necessitates the installation of pre-commit on top of add ing Ruff as a dependency.

As a hook, Ruff will check the codebase for formatting errors at the point where the developer makes a commit. If formatting errors are present, the hook will reject the commit and Ruff can try to auto-fix these errors. If they can be automatically fixed, then the developer can proceed to do the commit. Otherwise the error should be fixed manually.

Consistent formatting is important for collaborative work. There are a multitude of different formatters and different code formats. By enforcing one standard, we keep consistency in the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant