Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (45 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 1.35 KB

Contributing

Want to contribute to libthumbor? Welcome aboard.

This guide covers the basics for setting up your environment, validating changes, and preparing a pull request.

Getting Started

Fork the repository and clone your fork locally. If you need a refresher on that workflow, GitHub's fork documentation is a good place to start: http://help.github.com/fork-a-repo/.

Dependencies

Use Poetry so your local environment matches the project's tooling and CI.

  • Python 3.10 or newer
  • Poetry

Install the project and development dependencies with:

make setup

Running Tests

Run the full local validation flow with:

make test

You can also run individual targets when you only need part of the suite:

make unit
make coverage
make black
make flake8
make isort-check
make pylint

Pull Requests

Before opening a pull request:

  • Rebase your branch on top of the latest master
  • Run the relevant test and lint targets locally
  • Keep the change focused and update tests when behavior changes

If you want to track the upstream repository as an extra remote:

git remote add libthumbor git://github.com/thumbor/libthumbor.git

To update your branch with upstream master:

git pull libthumbor master

If that pull brings in changes, run the test suite again before opening your pull request.