To make a contribution to the Databricks Labs projects such as dbx, please fill in and sign the CLA (you can find the template in contrib/databricks_cla.pdf
) and send it to the email mentioned in this document.
Please add ivan.trusov@databricks.com to the cc, so I can internally track the status of the CLA.
We happily welcome contributions to dbx
.
We use GitHub Issues to track community reported issues and GitHub Pull Requests for accepting changes.
Please create a PR only if you've created an issue related to it. PRs without a linked issue won't be reviewed.
As a starting point, please install new environment as described in Makefile. To make e2e runs you'll need a Databricks account, and a configured profile.
make
: This is the gnu make tool.hatch
: https://github.com/pypa/hatch
Once you have the pre-requisites installed, you can run project functions like this:
make help
make clean install
make test
make test /tests/path/to/blah_test.py
make fix
make lint
- Please create a fork of this repository, and a development branch in it. You can name the branch as you would like to, but please make the branch name meaningful.
- After finishing the development, please run the
make lint
to make sure that code is properly formatted. - When opening a PR, it's mandatory to reference an issue (or set of issues) it resolves. PRs without linked issues won't be reviewed.
- Please describe the PR is 4-5 meaningful sentences. These sentences shall answer 3W questions (What is the problem, What is the impact, What is the solution)
- Please add tests to your PR. PRs which decrease the coverage metric won't be resolved, unless it's a special case of a big refactoring.
- If you add new functionality, please add some meaningful descriptions to the docs folder.
- All commits shall have a GPG signature verification as per this documentation.
Please let us know if you've met a problem in the development setup via raising an issue. Happy coding!