AllenNeuralDynamics / aind-mri-utils

Allen Institute for Neural Dynamics MRI utilities

MIT License

0 stars 0 forks source link

Automatically run and check-in black and isort linters #11

Open jtyoung84 opened 1 year ago

jtyoung84 commented 1 year ago

User story

As a developer, I want a github action to run and commit linters, so I don't have to worry about running it locally before pushing commits.

Acceptance criteria

[ ] When a PR is opened, there should be a step to automatically run black . and isort . and commit the changes to the current branch.

Sprint Ready Checklist

[ ] 1. Acceptance criteria defined
[ ] 2. Team understands acceptance criteria
[ ] 3. Team has defined solution / steps to satisfy acceptance criteria
[ ] 4. Acceptance criteria is verifiable / testable
[ ] 5. External / 3rd Party dependencies identified
[ ] 6. Ticket is prioritized and sized

Notes

Add any helpful notes here.

galenlynch commented 3 months ago

Sorry @jtyoung84 I just noticed that you might have planned to work on this? The scripts dir has something that looks like your work.

jtyoung84 commented 3 months ago

That script was from a request you had to be able to run the linters and tests in one command.

I can assign someone to do this ticket that will auto push the linter changes to main when a PR is merged. The basic workflow will look like:

Someone opens a PR
A GitHub action runs the linters and checks format
If the PR is merged, then any changes made by the linters will be committed to the main branch