Skip to content

Latest commit

 

History

History
117 lines (85 loc) · 5.5 KB

CONTRIBUTING.md

File metadata and controls

117 lines (85 loc) · 5.5 KB
Raw

Contributing to the Python APM Agent

The APM Agent is open source and we love to receive contributions from our community — you!

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code.

You can get in touch with us through Discuss, feedback and ideas are always welcome.

Please note that this repository is covered by the Elastic Community Code of Conduct.

Code contributions

If you have a bugfix or new feature that you would like to contribute, please find or open an issue about it first. Talk about what you would like to do. It may be that somebody is already working on it, or that there are particular issues that you should know about before implementing the change.

Submitting your changes

Generally, we require that you test any code you are adding or modifying. Once your changes are ready to submit for review:

  1. Sign the Contributor License Agreement

    Please make sure you have signed our Contributor License Agreement. We are not asking you to assign copyright to us, but to give us the right to distribute your code without restriction. We ask this of all contributors in order to assure our users of the origin and continuing existence of the code. You only need to sign the CLA once.

  2. Code style

    This project uses several tools to maintain a consistent code style:

    • the automatic code formatter black
    • sorting of imports via isort
    • flake8
    • License header check via custom script

    The easiest way to make sure your pull request adheres to the the code style is to install pre-commit.

     pip install pre-commit # or "brew install pre-commit" if you use Homebrew
 
 pre-commit install

  3. Test your changes

    Run the test suite to make sure that nothing is broken. See testing for details.

  4. Rebase your changes

    Update your local repository with the most recent code from the main repo, and rebase your branch on top of the latest master branch. We prefer your initial changes to be squashed into a single commit. Later, if we ask you to make changes, add them as separate commits. This makes them easier to review. As a final step before merging we will either ask you to squash all commits yourself or we'll do it for you.

  5. Submit a pull request

    Push your local changes to your forked copy of the repository and submit a pull request. In the pull request, choose a title which sums up the changes that you have made, and in the body provide more details about what your changes do. Also mention the number of the issue where discussion has taken place, eg "Closes #123".

  6. Be patient

    We might not be able to review your code as fast as we would like to, but we'll do our best to dedicate it the attention it deserves. Your effort is much appreciated!

Testing

To run the full test suite, you need to install several databases (Elasticsearch, PostgreSQL, MySQL, Cassandra, Redis). This can be quite a hassle, so we recommend to use our dockerized test setup. See Running tests for detailed instructions.

Workflow

All feature development and most bug fixes hit the master branch first. Pull requests should be reviewed by someone with commit access. Once approved, the author of the pull request, or reviewer if the author does not have commit access, should "Squash and merge".

Releasing

If you have commit access, the process is as follows:

  1. Update the version in elasticapm/version.py according to the scale of the change. (major, minor or patch)
  2. Update CHANGELOG.asciidoc. Rename the Unreleased section to the correct version (vX.X.X), and nest under the appropriate sub-heading, e.g., Python Agent version 5.x.
  3. For Majors: Add a new row to the EOL table in docs/upgrading.asciidoc. The EOL date is the release date plus 18 months.
  4. Commit changes with message update CHANGELOG and bump version to X.Y.Z where X.Y.Z is the version in elasticapm/version.py
  5. Tag the commit with git tag -a vX.Y.Z, for example git tag -a v1.2.3. Copy the changelog for the release to the tag message, removing any leading #.
  6. Reset the current major branch (1.x, 2.x etc) to point to the current master, e.g. git branch -f 1.x master
  7. Push commits and tags upstream with git push upstream master && git push upstream --tags (and optionally to your own fork as well)
  8. Update major branch, e.g. 1.x on upstream with git push upstream 1.x
  9. After tests pass, Jenkins will automatically build a source package, as well as binary wheels. To upload them to PyPI, go to Jenkins and look for the build with the correct tag name (vX.Y.Z). Once the build is done, a dialog will be shown. Note that you need to be logged in to trigger an upload.
  10. Create a Github release targeting the new tag. Copy the changelog into the body of the release.