This work adds the linter black as a dev dependency to the requirements-dev.txt, along with some Make targets to run the lint checks locally AND even do some of the fixes! This also fulfills the AC's listed in the referenced issue above.
Type of Change
I'm split on whether this is a Chore or a Feature. I feel like a Feature refers more to the application, where as this is code/repo overhead.
[ ] Bugfix (A non-breaking change that fixes an issue)
[X] Feature (A non-breaking change that adds new functionality)
[ ] Chore (A non-breaking change that adds no net new functionality, tests, refactoring, docs etc.)
[ ] Breaking Change (a fix or feature that is not backwards compatible with existing functionality)
Testing Steps
This should run once the github actions are in place. To illustrate the functionality, I'll push a failing commit to illustrate the ❌, as well as the subsequent ✅
Definition of Done Checklist
[x] I have only included commits that apply to the referenced Github Issue.
[x] I have performed a self-review of my own code.
[x] I have taken the time to refactor the code to ensure testability, and maintainability.
[x] I have made corresponding changes to the documentation (if needed).
[x] I have added tests that prove my fix/feature is working per requirements.
[x] I have provided sufficient code comments so any developer can support my code.
Description of Work
Add code linter
This work adds the linter
blackas a dev dependency to therequirements-dev.txt, along with someMaketargets to run the lint checks locally AND even do some of the fixes! This also fulfills the AC's listed in the referenced issue above.Type of Change
I'm split on whether this is a Chore or a Feature. I feel like a Feature refers more to the application, where as this is code/repo overhead.
Testing Steps
This should run once the github actions are in place. To illustrate the functionality, I'll push a failing commit to illustrate the ❌, as well as the subsequent ✅
Definition of Done Checklist