Thanks for interested to contribute to TerminusDB Client, to get started, fork this repo and follow the instruction setting up dev environment. If you don't have idea where to start, you can look for good first issue or help wanted label at issues. All pull request should follow the Pull Request Format Guideline and pull request (PR) that involving coding should come with tests and documentations.
Make sure you have Python>=3.6 installed. We use pipenv for dev environment, to install pipenv:
pip3 install pipenv --upgrade
Fork and clone this repo, then in your local repo:
pipenv install --dev --pre or make init
To “editable” install the local Terminus Client Python:
pip3 install -e .
to be able to run integration tests, local installation of docker is required
We use shed to lint our code. Although you can do it manually by running shed, we highly recommend setting up the pre-commit hook to do the linting automatically.
To install the pre-commit hook:
pre-commit install
We are using pytest for testing. All tests are stored in /tests
We also use tox to run tests in a virtual environment, we recommend running tox for the first time before you make any changes. This is to initialize the tox environments (or do it separately by tox -e deps) and make sure all tests pass initially.
To run the unittests without integration tests:
pytest terminusdb_client/tests/ --ignore=terminusdb_client/tests/integration_tests/
To run all tests including integration tests:
tox -e test
To run all checks and auto formatting:
tox -e check
To run all tests and checks:
tox
please make sure tox passes before making PR
Please follow numpydoc docstring guide for documentation. It is important to follow the formatting as all documentation will be automatically rendered using Sphinx.
To render the documentation locally (for preview before making your PR):
cd docs
make html
The built documentation will be in /build/html/ which you can open index.html in your browser to check.
now you are in docs directory, make sure you go back to the top directory of the repo if you want to commit and push
Please put the type of the pull request in the title:
- [Doc] for documentation
- [Bug] for bug fixes
- [Feature] for new features
- [WIP] for work in progress (will not be reviewed)
Also, if there is a related issues, please also put the issue numbers in blankets in the title, for example: (#10)
It will be great to describe what you have done in the pull request (more detail the better). If there is an issue that can be closed by this PR, you can put Close #XX or Fix #XX (while XX is the issue number) to close that issue automatically when your PR is merged.
Following the guideline makes the reviewing process of the PR much efficient.