| ============ |
| Contributing |
| ============ |
| |
| Please read the `code of conduct <https://github.com/dagworks-inc/burr/tree/main/CODE_OF_CONDUCT.md>`_ |
| prior to contributing. Then follow these guidelines: |
| |
| #. Create a fork of the repository. |
| #. Ensure all tests pass |
| #. Make a PR to the main repository |
| #. Ping one of the maintainers to review your PR (best way to reach us is via the `slack community <https://join.slack.com/t/hamilton-opensource/shared_invite/zt-1bjs72asx-wcUTgH7q7QX1igiQ5bbdcg>`_) |
| |
| ----------------------- |
| Contribution guidelines |
| ----------------------- |
| |
| Please: |
| |
| #. Keep your commits modular |
| #. Add descriptive commit messages |
| #. Attach a PR to an issue if applicable |
| #. Ensure all new features have tests |
| #. Add documentation for new features |
