Skip to content

Latest commit

 

History

History
116 lines (88 loc) · 5.85 KB

CONTRIBUTING.md

File metadata and controls

116 lines (88 loc) · 5.85 KB
Raw

Contributing to Paho

Thanks for your interest in this project!

You can contribute bugfixes and new features by sending pull requests through GitHub.

Legal

In order for your contribution to be accepted, it must comply with the Eclipse Foundation IP policy.

Please read the Eclipse Foundation policy on accepting contributions via Git.

  1. Sign the Eclipse CLA
  2. Register for an Eclipse Foundation User ID. You can register here.
  3. Log into the Projects Portal, and click on the 'Eclipse CLA' link.
  4. Go to your account settings and add your GitHub username to your account.
  5. Make sure that you sign-off your Git commits in the following format: Signed-off-by: John Smith <[email protected]> This is usually at the bottom of the commit message. You can automate this by adding the '-s' flag when you make the commits. e.g. git commit -s -m "Adding a cool feature"
  6. Ensure that the email address that you make your commits with is the same one you used to sign up to the Eclipse Foundation website with.

Contributing a change

  1. Fork the repository on GitHub

  2. Clone the forked repository onto your computer: git clone https://github.com/<your username>/paho.mqtt.python.git

  3. Most changes will go to branch master. This include both bug fixes and new features. Bug fixes are committed to master and if required, cherry-picked to the release branch.

    The only changes that goes directly to the release branch (1.4, 1.5, ...) are bug fixes that does not apply to master (e.g. because there are fixed on master by a refactoring, or any other huge change we do not want to cherry-pick to the release branch).

  4. Create a new branch from the latest master branch with git checkout -b YOUR_BRANCH_NAME origin/master

  5. Make your changes

  6. Ensure that all new and existing tests pass by running tox

  7. Commit the changes into the branch: git commit -s Make sure that your commit message is meaningful and describes your changes correctly.

  8. If you have a lot of commits for the change, squash them into a single / few commits.

  9. Push the changes in your branch to your forked repository.

  10. Finally, go to https://github.com/eclipse/paho.mqtt.python and create a pull request from your "YOUR_BRANCH_NAME" branch to the master (or release branch if applicable) to request review and merge of the commits in your pushed branch.

What happens next depends on the content of the patch. If it is 100% authored by the contributor and is less than 1000 lines (and meets the needs of the project), then it can be pulled into the main repository. If not, more steps are required. These are detailed in the legal process poster.

Developer resources:

Information regarding source code management, builds, coding standards, and more.

Contact:

Contact the project developers via the project's development mailing list.

Search for bugs:

This project uses Github to track ongoing development and issues.

Create a new bug:

Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome!

Committer resources:

Making a release

The process to make a release is the following:

  • Using a virtual env with the following tool installed: pip install build sphinx twine
  • In that same virtual env, install paho itself (required for docs): pip install -e .
  • Update the Changelog with the release version and date. Ensure it's up-to-date with latest fixes & PRs merged.
  • Make sure test pass, check that Github actions are green.
  • Check that documentation build (cd docs; make clean html)
  • Bump the version number in paho/mqtt/__init__.py, commit the change.
  • Make a dry-run of build:
    • Build release: python -m build .
    • Check with twine for common errors: python -m twine check dist/*
    • Try uploading it to testpypi: python3 -m twine upload --repository testpypi dist/*
  • Do a GPG signed tag (assuming your GPG is correctly configured, it's git tag -s -m "Version 1.2.3" v1.2.3)
  • Push the commit and it's tag to Github
  • Make sure your git is clean, especially the dist/ folder.
  • Build a release: python -m build .
  • You can also get the latest build from Github action. It should be identical to your local build: https://github.com/eclipse/paho.mqtt.python/actions/workflows/build.yml?query=branch%3Amaster
  • Then upload the dist file, you can follow instruction on https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives It should mostly be python -m twine upload dist/*
  • Create a release on Github, copy-pasting the release note from Changelog.
  • Build and publish the documentation
  • Announce the release on the Mailing list.
  • To allow installing from a git clone, update the version in paho/mqtt/__init__.py to next number WITH .dev0 (example 1.2.3.dev0)