If you wish to add a new feature or fix a bug:
Check for open issues or open a new issue to start a discussion around a feature idea or a bug. Issues labeled as Contributor Friendly are ideal for individuals who are not yet familiar with the codebase.
Fork the dataclay repository on Github to start making your changes.
Write a test which shows that the bug was fixed or that the feature works as expected.
Format your changes with Black using the command tox -e format and lint your changes using the command tox -e lint.
Send a pull request and follow up with the maintainer until it gets merged and published.
Setting up your development environment#
To set up your development environment, you will need tox installed on your machine:
$ python -m pip install --user --upgrade tox
Install dataClay in editable mode with the
dev extra requirement:
$ pip install -e .[dev,telemetry]
Running the tests#
When running the test suite, we use external dependencies, multiple interpreters, and code coverage analysis. Our tox.ini file handles much of this for you: