Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
163 lines (106 loc) · 5.73 KB

CONTRIBUTING.md

File metadata and controls

163 lines (106 loc) · 5.73 KB
Raw

Contributing to Pycloudinary

Contributions are welcome and greatly appreciated!

Reporting a bug

  • Ensure that the bug was not already reported by searching in GitHub under Issues and the Cloudinary Support forms.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
  • If you require assistance in the implementation of pycloudinary please submit a request in the Cloudinary web site.

Requesting a feature

We would love to hear your requests! Please be aware that the package is used in a wide variety of environments and that some features may not be applicable to all users.

  • Open a GitHub issue describing the benefits (and possible drawbacks) of the requested feature

Fixing a bug / Implementing a new feature

  • Follow the instructions detailed in Code contribution
  • Open a new GitHub pull request
  • Ensure the PR description clearly describes the bug / feature. Include the relevant issue number if applicable.
  • Provide test code that covers the new code
  • Make sure that your code works both with and without Django
  • The code should support the versions tested in CI:
    • Python 3.10 - 3.14
    • Django 4.2, 5.0, 5.1, 5.2, 6.0

Code contribution

When contributing code, either to fix a bug or to implement a new feature, please follow these guidelines:

Fork the Project

Fork project on Github and check out your copy.

git clone https://github.com/contributor/pycloudinary.git
cd pycloudinary
git remote add upstream https://github.com/cloudinary/pycloudinary.git

Create a Topic Branch

Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.

git checkout master
git pull upstream master
git checkout -b my-feature-branch

Rebase

If you've been working on a change for a while, rebase with upstream/master.

git fetch upstream
git rebase upstream/master
git push origin my-feature-branch -f

Write Tests

Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to test.

We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.

Write Code

Implement your feature or bug fix. Try to follow PEP8. Make sure that your code works both with and without Django. The code should support the versions tested in CI:

  • Python 3.10 - 3.14
  • Django 4.2, 5.0, 5.1, 5.2, 6.0

Make sure that tests completes without errors.

Write Documentation

Document any external behavior in the bundled task docs under cloudinary/docs — these ship inside the published package and are the source of truth for the installed version. Add a matching runnable file to examples when the change introduces a new task, and keep the two consistent. The README links the task docs; update it only when the set of tasks changes.

Running the tests

Run the basic test suite with your CLOUDINARY_URL:

CLOUDINARY_URL=cloudinary://apikey:apisecret@cloudname python -m pytest test

The suite runs against the live API, so a working CLOUDINARY_URL is required. If you do not have credentials, provision a throwaway cloud with python -c "from cloudinary.provisioning import create_cloud; print(create_cloud())".

Run the Django suite separately:

DJANGO_SETTINGS_MODULE=django_tests.settings django-admin test -v2 django_tests

This only runs the tests for the current environment. GitHub Actions will run the full suite when you submit your pull request.

The full test suite takes a long time to run because it tests multiple combinations of Python and Django. You need the Python versions listed above installed to run all environments. Then run:

CLOUDINARY_URL=cloudinary://apikey:apisecret@cloudname tox

Commit Changes

Make sure git knows your name and email address:

git config --global user.name "Your Name"
git config --global user.email "contributor@example.com"

Writing good commit logs is important. A commit log should describe what changed and why.

git add ...
git commit

Please squash your commits into a single commit when appropriate. This simplifies future cherry picks and keeps the git log clean.

Push

git push origin my-feature-branch

Make a Pull Request

Go to https://github.com/contributor/pycloudinary and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days. Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Rebase

If you've been working on a change for a while, rebase with upstream/master.

git fetch upstream
git rebase upstream/master
git push origin my-feature-branch -f

Check on Your Pull Request

Go back to your pull request after a few minutes and see whether it passed muster with GitHub Actions. Everything should look green, otherwise fix issues and amend your commit as described above.

Be Patient

It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!

Thank You

Please do know that we really appreciate and value your time and work. We love you, really.