causalml
causalml copied to clipboard
Precommit
Proposed changes
Adding basic pre-commit hooks. This will make it so that black formatting is run before every commit.
Types of changes
What types of changes does your code introduce to CausalML?
Put an x in the boxes that apply
- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [x] Documentation Update (if none of the other choices apply)
Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
- [x] I have read the CONTRIBUTING doc
- [x] I have signed the CLA
- [x] Lint and unit tests pass locally with my changes
- [x] I have added tests that prove my fix is effective or that my feature works
- [x] I have added necessary documentation (if appropriate)
- [x] Any dependent changes have been merged and published in downstream modules
Further comments
This isn't exactly a feature, but will allow for more uniform formatting assuming contributors install the pre-commit hooks. I have updated docs to reflect but feel free to suggest any more changes.