We rely on pull requests to keep this project maintained. By participating in this project, you agree to abide by the project code of conduct.
Fork, then clone the repo:
git clone [email protected]:carbonblack/carbon-black-cloud-sdk-python.git
It is recommended to use virtualenv to set up the project. Once you have that you can use it to generate a virtual environment, activate it and install the package.
python3 -m virtualenv ./venv
source venv/bin/activate
python3 setup.py develop
Make sure the tests pass:
pytest
Install the dev dependencies and after that it is highly recommended installing pre-commit.
pip install -r requirements.txt
pre-commit install
...
The pre-commit will make sure that you have the right code quality before committing your changes.
Make sure to:
- Write documentation and tests.
- Perform all the other tests.
- Push to your fork and submit a pull request.
We try to respond to pull requests as quickly as possible. We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Write tests.
- Follow PEP-8, flake8, and clean code principles.
- Write a good commit message.
- Usage of pre-commit