Skip to content

Latest commit

 

History

History
64 lines (38 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

64 lines (38 loc) · 1.68 KB
Raw

How to contribute

Thanks for your interest in contributing to the Kinto client!

Reporting Bugs

Report bugs at https://github.com/Kinto/kinto-http.py/issues/new

If you are reporting a bug, please include:

  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug or even a PR with a failing tests if you can.

Ready to contribute?

Getting Started

  • Fork the repo on GitHub and clone locally:
git clone [email protected]:Kinto/kinto-http.py.git
git remote add {your_name} [email protected]:{your_name}/kinto-http.py.git

Optionally, configure git to use .git-blame-ignore-revs to remove noisy commits from git blame (e.g. running formatters or moving files):

::

git config blame.ignoreRevsFile .git-blame-ignore-revs

Testing

  • Run make run-kinto in a separate terminal

  • make tests to run all the tests

If you want to run the functional tests only, you can use make functional.

Submitting Changes

git checkout main
git pull origin main
git checkout -b issue_number-bug-title
git commit # Your changes
git push -u {your_name} issue_number-bug-title

Then you can create a Pull-Request. Please create your pull-request as soon as you have at least one commit even if it has only failing tests. This will allow us to help and give guidance.

You will be able to update your pull-request by pushing commits to your branch.

Releasing

  1. Create a release on Github on https://github.com/Kinto/kinto-http.py/releases/new
  2. Create a new tag X.Y.Z (This tag will be created from the target when you publish this release.)
  3. Generate release notes
  4. Publish release