Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

73 lines (49 loc) · 1.89 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Developer Installation

If something goes wrong at any point during installing the library please see how our CI/CD on GitHub Actions installs and builds the project as it will always be the most up-to-date.

Get Started!

Ready to contribute? Here's how to set up cdp-backend for local development.

  1. Fork the cdp-backend repo on GitHub.

  2. Clone your fork locally:

    git clone [email protected]:{your_name_here}/cdp-backend.git

  3. Install graphviz

  4. Install ffmpeg

  5. Install the project in editable mode. (It is also recommended to work in a virtualenv or anaconda environment):

    cd cdp-backend/
pip install -e .[dev]

  6. Create a branch for local development:

    git checkout -b {your_development_type}/short-description

    Ex: feature/read-tiff-files or bugfix/handle-file-not-found
    Now you can make your changes locally.

  7. When you're done making changes, check that your changes pass linting and tests, including testing other Python versions with make:

    make build

  8. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Resolves gh-###. Your detailed description of your changes."
git push origin {your_development_type}/short-description

  9. Submit a pull request through the GitHub website.

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed. Then run:

$ bump2version dev_release # possible: major / minor / patch / dev_release
$ git push
$ git push --tags

This will release a new package version on Git + GitHub and publish to PyPI.