Skip to content

Update CONTRIBUTING.md #2411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sentrivana merged 12 commits into from
Oct 4, 2023
Merged

Update CONTRIBUTING.md #2411

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
aeacda3
Update CONTRIBUTING.md
sentrivana Oct 4, 2023
9cfb61b
wording
sentrivana Oct 4, 2023
5493154
more wording
sentrivana Oct 4, 2023
bf96433
Merge branch 'master' into ivana/improve-readme
sentrivana Oct 4, 2023
e2974c4
add a note to monkeypatching
sentrivana Oct 4, 2023
8fe442d
Update CONTRIBUTING.md
sentrivana Oct 4, 2023
a15722f
Apply suggestions from code review
sentrivana Oct 4, 2023
1e1a1e0
apply suggestions
sentrivana Oct 4, 2023
c5fd574
remove the commit msg guidelines section
sentrivana Oct 4, 2023
381a7b7
Merge branch 'master' into ivana/improve-readme
sentrivana Oct 4, 2023
cc9799f
Update CONTRIBUTING.md
sentrivana Oct 4, 2023
25a9b27
apply suggestion
sentrivana Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 79 additions & 83 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,53 +1,63 @@
# Contributing to Sentry SDK for Python

We welcome contributions to python-sentry by the community. See the [Contributing to Docs](https://docs.sentry.io/contributing/) page if you want to fix or update the documentation on the website.
We welcome contributions to `sentry-python` by the community.

## How to report a problem
This file outlines the process to contribute to the SDK itself. For contributing to the documentation, please see the [Contributing to Docs](https://docs.sentry.io/contributing/) page.

Please search the [issue tracker](https://github.com/getsentry/sentry-python/issues) before creating a new issue (a problem or an improvement request). Please also ask in our [Sentry Community on Discord](https://discord.com/invite/Ww9hbqr) before submitting a new issue. There is a ton of great people in our Discord community ready to help you!
## How to Report a Problem

If you feel that you can fix or implement it yourself, please read a few paragraphs below to learn how to submit your changes.
Please search the [issue tracker](https://github.com/getsentry/sentry-python/issues) before creating a new issue (a problem or an improvement request). Please also ask in our [Sentry Community on Discord](https://discord.com/invite/Ww9hbqr) before submitting a new issue. There are a ton of great people in our Discord community ready to help you!

## Submitting changes

- Setup the development environment.
- Clone sentry-python and prepare necessary changes.
## Submitting Changes

- Fork the `sentry-python` repo and prepare your changes.
- Add tests for your changes to `tests/`.
- Run tests and make sure all of them pass.
- Submit a pull request, referencing any issues it addresses.
- Submit a pull request, referencing any issues your changes address. Please follow our [commit message format](https://develop.sentry.dev/commit-messages/#commit-message-format) when naming your pull request.

We will review your pull request as soon as possible.
Thank you for contributing!
We will review your pull request as soon as possible. Thank you for contributing!

## Development environment
## Development Environment

### Clone the repo:
### Set up Python

```bash
git clone git@github.com:getsentry/sentry-python.git
```
Make sure that you have Python 3 installed. Version 3.7 or higher is required to run style checkers on pre-commit.

On macOS, we recommend using `brew` to install Python. For Windows, we recommend an official [python.org](https://www.python.org/downloads/) release.

### Fork and Clone the Repo

Make sure that you have Python 3 installed. Version 3.7 or higher is required to run style checkers on pre-commit. On macOS, we recommend using brew to install Python. For Windows, we recommend an official python.org release.
Before you can contribute, you will need to [fork the `sentry-python` repository](https://github.com/getsentry/sentry-python/fork). Then, clone the forked repository to your local development environment.

### Create a virtual environment:
### Create a Virtual Environment

To keep your Python development environment and packages separate from the ones
used by your operation system, create a virtual environment:

```bash
cd sentry-python

python -m venv .venv
```

Then, activate your virtual environment with the following command. You will need to repeat this step every time you wish to work on your changes for `sentry-python`.

```bash
source .venv/bin/activate
```

### Install `sentry-python` in editable mode
### Install `sentry-python` in Editable Mode

Install `sentry-python` in [editable mode](https://pip.pypa.io/en/latest/topics/local-project-installs/#editable-installs). This will make any changes you make to the SDK code locally immediately effective without you having to reinstall or copy anything.

```bash
pip install -e .
```

**Hint:** Sometimes you need a sample project to run your new changes to sentry-python. In this case install the sample project in the same virtualenv and you should be good to go because the ` pip install -e .` from above installed your local sentry-python in editable mode.
**Hint:** Sometimes you need a sample project to run your new changes to `sentry-python`. In this case install the sample project in the same virtualenv and you should be good to go.

### Install coding style pre-commit hooks:
### Install Coding Style Pre-commit Hooks

This will make sure that your commits will have the correct coding style.

Expand All @@ -63,7 +73,7 @@ pre-commit install

That's it. You should be ready to make changes, run tests, and make commits! If you experience any problems, please don't hesitate to ping us in our [Discord Community](https://discord.com/invite/Ww9hbqr).

## Running tests
## Running Tests

To run the tests, first setup your development environment according to the instructions above. Then, install the required packages for running tests with the following command:
```bash
Expand All @@ -81,103 +91,89 @@ If you would like to run the tests for a specific integration, use a command sim
pytest -rs tests/integrations/flask/ # Replace "flask" with the specific integration you wish to test
```

**Hint:** Tests of integrations need additional dependencies. The switch `-rs` will show you why tests where skipped and what dependencies you need to install for the tests to run. (You can also consult the [tox.ini](tox.ini) file to see what dependencies are installed for each integration)

## Releasing a new version

(only relevant for Sentry employees)

Prerequisites:

- All the changes that should be release must be in `master` branch.
- Every commit should follow the [Commit Message Format](https://develop.sentry.dev/commit-messages/#commit-message-format) convention.
- CHANGELOG.md is updated automatically. No human intervention necessary.

Manual Process:

- On GitHub in the `sentry-python` repository go to "Actions" select the "Release" workflow.
- Click on "Run workflow" on the right side, make sure the `master` branch is selected.
- Set "Version to release" input field. Here you decide if it is a major, minor or patch release. (See "Versioning Policy" below)
- Click "Run Workflow"
**Hint:** Tests of integrations need additional dependencies. The switch `-rs` will show you why tests were skipped and what dependencies you need to install for the tests to run. (You can also consult the [tox.ini](tox.ini) file to see what dependencies are installed for each integration)

This will trigger [Craft](https://github.com/getsentry/craft) to prepare everything needed for a release. (For more information see [craft prepare](https://github.com/getsentry/craft#craft-prepare-preparing-a-new-release)) At the end of this process a release issue is created in the [Publish](https://github.com/getsentry/publish) repository. (Example release issue: https://github.com/getsentry/publish/issues/815)
## Adding a New Integration

Now one of the persons with release privileges (most probably your engineering manager) will review this Issue and then add the `accepted` label to the issue.
1. Write the integration.

There are always two persons involved in a release.
- Instrument all application instances by default. Prefer global signals/patches instead of configuring a specific instance. Don't make the user pass anything to your integration for anything to work. Aim for zero configuration.

If you are in a hurry and the release should be out immediatly there is a Slack channel called `#proj-release-approval` where you can see your release issue and where you can ping people to please have a look immediatly.
- Everybody monkeypatches. That means:

When the release issue is labeled `accepted` [Craft](https://github.com/getsentry/craft) is triggered again to publish the release to all the right platforms. (See [craft publish](https://github.com/getsentry/craft#craft-publish-publishing-the-release) for more information). At the end of this process the release issue on GitHub will be closed and the release is completed! Congratulations!
- Make sure to think about conflicts with other monkeypatches when monkeypatching.

There is a sequence diagram visualizing all this in the [README.md](https://github.com/getsentry/publish) of the `Publish` repository.
- You don't need to feel bad about it.

### Versioning Policy
- Make sure your changes don't break end user contracts. The SDK should never alter the expected behavior of the underlying library or framework from the user's perspective and it shouldn't have any side effects.

This project follows [semver](https://semver.org/), with three additions:

- Semver says that major version `0` can include breaking changes at any time. Still, it is common practice to assume that only `0.x` releases (minor versions) can contain breaking changes while `0.x.y` releases (patch versions) are used for backwards-compatible changes (bugfixes and features). This project also follows that practice.
- Avoid modifying the hub, registering a new client or the like. The user drives the client, and the client owns integrations.

- All undocumented APIs are considered internal. They are not part of this contract.
- Allow the user to turn off the integration by changing the client. Check `Hub.current.get_integration(MyIntegration)` from within your signal handlers to see if your integration is still active before you do anything impactful (such as sending an event).

- Certain features (e.g. integrations) may be explicitly called out as "experimental" or "unstable" in the documentation. They come with their own versioning policy described in the documentation.
2. Write tests.

We recommend to pin your version requirements against `1.x.*` or `1.x.y`.
Either one of the following is fine:
- Consider the minimum versions supported, and test each version in a separate env in `tox.ini`.

```
sentry-sdk>=1.0.0,<2.0.0
sentry-sdk==1.5.0
```
- Create a new folder in `tests/integrations/`, with an `__init__` file that skips the entire suite if the package is not installed.

A major release `N` implies the previous release `N-1` will no longer receive updates. We generally do not backport bugfixes to older versions unless they are security relevant. However, feel free to ask for backports of specific commits on the bugtracker.
3. Update package metadata.

## Adding a new integration (checklist)
- We use `extras_require` in `setup.py` to communicate minimum version requirements for integrations. People can use this in combination with tools like Poetry or Pipenv to detect conflicts between our supported versions and their used versions programmatically.

1. Write the integration.
Do not set upper bounds on version requirements as people are often faster in adopting new versions of a web framework than we are in adding them to the test matrix or our package metadata.

- Instrument all application instances by default. Prefer global signals/patches instead of configuring a specific instance. Don't make the user pass anything to your integration for anything to work. Aim for zero configuration.
4. Write the [docs](https://github.com/getsentry/sentry-docs). Follow the structure of [existing integration docs](https://docs.sentry.io/platforms/python/integrations/). And, please **make sure to add your integration to the table in `python/integrations/index.md`** (people often forget this step 🙂).

- Everybody monkeypatches. That means:
5. Merge docs after new version has been released. The docs are built and deployed after each merge, so your changes should go live in a few minutes.

- Make sure to think about conflicts with other monkeypatches when monkeypatching.
6. (optional, if possible) Update data in [`sdk_updates.py`](https://github.com/getsentry/sentry/blob/master/src/sentry/sdk_updates.py) to give users in-app suggestions to use your integration. This step will only apply to some integrations.

- You don't need to feel bad about it.
## Releasing a New Version

- Avoid modifying the hub, registering a new client or the like. The user drives the client, and the client owns integrations.
_(only relevant for Sentry employees)_

- Allow the user to disable the integration by changing the client. Check `Hub.current.get_integration(MyIntegration)` from within your signal handlers to see if your integration is still active before you do anything impactful (such as sending an event).
### Prerequisites

2. Write tests.
- All the changes that should be released must be on the `master` branch.
- Every commit should follow the [Commit Message Format](https://develop.sentry.dev/commit-messages/#commit-message-format) convention.
- CHANGELOG.md is updated automatically. No human intervention is necessary, but you might want to consider polishing the changelog by hand to make it more user friendly by grouping related things together, adding small code snippets and links to docs, etc.

- Think about the minimum versions supported, and test each version in a separate env in `tox.ini`.
### Manual Process

- Create a new folder in `tests/integrations/`, with an `__init__` file that skips the entire suite if the package is not installed.
- On GitHub in the `sentry-python` repository, go to "Actions" and select the "Release" workflow.
- Click on "Run workflow" on the right side, and make sure the `master` branch is selected.
- Set the "Version to release" input field. Here you decide if it is a major, minor or patch release. (See "Versioning Policy" below)
- Click "Run Workflow".

3. Update package metadata.
This will trigger [Craft](https://github.com/getsentry/craft) to prepare everything needed for a release. (For more information, see [craft prepare](https://github.com/getsentry/craft#craft-prepare-preparing-a-new-release).) At the end of this process a release issue is created in the [Publish](https://github.com/getsentry/publish) repository. (Example release issue: https://github.com/getsentry/publish/issues/815)

- We use `extras_require` in `setup.py` to communicate minimum version requirements for integrations. People can use this in combination with tools like Poetry or Pipenv to detect conflicts between our supported versions and their used versions programmatically.
Now one of the persons with release privileges (most probably your engineering manager) will review this issue and then add the `accepted` label to the issue.

Do not set upper-bounds on version requirements as people are often faster in adopting new versions of a web framework than we are in adding them to the test matrix or our package metadata.
There are always two persons involved in a release.

4. Write the [docs](https://github.com/getsentry/sentry-docs). Answer the following questions:
If you are in a hurry and the release should be out immediately, there is a Slack channel called `#proj-release-approval` where you can see your release issue and where you can ping people to please have a look immediately.

- What does your integration do? Split in two sections: Executive summary at top and exact behavior further down.
When the release issue is labeled `accepted`, [Craft](https://github.com/getsentry/craft) is triggered again to publish the release to all the right platforms. (See [craft publish](https://github.com/getsentry/craft#craft-publish-publishing-the-release) for more information.) At the end of this process the release issue on GitHub will be closed and the release is completed! Congratulations!

- Which version of the SDK supports which versions of the modules it hooks into?
There is a sequence diagram visualizing all this in the [README.md](https://github.com/getsentry/publish) of the `Publish` repository.

- One code example with basic setup.
### Versioning Policy

- Make sure to add integration page to `python/index.md` (people forget to do that all the time).
This project follows [semver](https://semver.org/), with three additions:

Tip: Put most relevant parts wrapped in `<!--WIZARD-->..<!--ENDWIZARD-->` tags for usage from within the Sentry UI.
- Semver says that major version `0` can include breaking changes at any time. Still, it is common practice to assume that only `0.x` releases (minor versions) can contain breaking changes while `0.x.y` releases (patch versions) are used for backwards-compatible changes (bugfixes and features). This project also follows that practice.

5. Merge docs after new version has been released (auto-deploys on merge).
- All undocumented APIs are considered internal. They are not part of this contract.

6. (optional) Update data in [`sdk_updates.py`](https://github.com/getsentry/sentry/blob/master/src/sentry/sdk_updates.py) to give users in-app suggestions to use your integration. May not be applicable or doable for all kinds of integrations.
- Certain features (e.g. integrations) may be explicitly called out as "experimental" or "unstable" in the documentation. They come with their own versioning policy described in the documentation.

## Commit message format guidelines
We recommend to pin your version requirements against `1.x.*` or `1.x.y`.
Either one of the following is fine:

See the documentation on commit messages here:
```
sentry-sdk>=1.0.0,<2.0.0
sentry-sdk==1.5.0
```

https://develop.sentry.dev/commit-messages/#commit-message-format
A major release `N` implies the previous release `N-1` will no longer receive updates. We generally do not backport bugfixes to older versions unless they are security relevant. However, feel free to ask for backports of specific commits on the bugtracker.