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

Use a code formatter and pre-commit hooks #25

Closed
edbennett opened this issue Feb 2, 2024 · 6 comments
Closed

Use a code formatter and pre-commit hooks #25

edbennett opened this issue Feb 2, 2024 · 6 comments
Assignees
Labels
high priority Changes that others will build on, or that give a good reward-effort ratio

Comments

@edbennett
Copy link
Collaborator

I'd suggest using ruff format to automatically reformat the code in a standard style, and then impose this style on all future commits with a pre-commit hook.

This was referenced Feb 2, 2024
@edbennett edbennett added the high priority Changes that others will build on, or that give a good reward-effort ratio label Feb 2, 2024
@edbennett
Copy link
Collaborator Author

@nickforce989 Can you look at this next, please? I think this shouldn't take you longer than an hour.

@nickforce989 nickforce989 self-assigned this Feb 15, 2024
@nickforce989
Copy link
Collaborator

nickforce989 commented Feb 15, 2024

@edbennett, yes I will look into this as next issue.

nickforce989 pushed a commit that referenced this issue Feb 16, 2024
nickforce989 pushed a commit that referenced this issue Feb 16, 2024
nickforce989 pushed a commit that referenced this issue Feb 16, 2024
nickforce989 pushed a commit that referenced this issue Feb 16, 2024
nickforce989 pushed a commit that referenced this issue Feb 21, 2024
@edbennett
Copy link
Collaborator Author

Before closing this, run pre-commit run --all and commit any fixes that it suggests.

@edbennett
Copy link
Collaborator Author

(Note that if you think a commit will fix an issue, you can use the literal text fixes #number or fix #number or closes #number in the commit message and it will happen automatically. I'd recommend only using this in a branch so that the changes can be reviewed a pull request before the issues gets automatically closed.)

nickforce989 pushed a commit that referenced this issue Feb 21, 2024
@nickforce989
Copy link
Collaborator

Done!

@edbennett
Copy link
Collaborator Author

I'd recommend using 5–10 words to describe the issue being fixed rather than just referencing an issue number, for the benefit of those reading the git log in future who may not have the GitHub up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
high priority Changes that others will build on, or that give a good reward-effort ratio
Projects
None yet
Development

No branches or pull requests

2 participants