From aeacda34187433973edd05885257854dd3db1bb5 Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 4 Oct 2023 11:07:07 +0200 Subject: [PATCH 01/10] Update CONTRIBUTING.md --- CONTRIBUTING.md | 157 +++++++++++++++++++++++++----------------------- 1 file changed, 82 insertions(+), 75 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c71be18823..4716e87706 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,35 +1,50 @@ # 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. +Thank you for your interest in contributing to `sentry-python`! -## 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. + +## How to Report a Problem 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! If you feel that you can fix or implement it yourself, please read a few paragraphs below to learn how to submit your changes. -## Submitting changes +## Submitting Changes -- Setup the development environment. -- Clone sentry-python and prepare necessary 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. -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 + +### Set up Python + +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. -## Development environment +### Fork the Repo -### Clone the repo: +Go to the [home page of the repo](https://github.com/getsentry/sentry-python), click the "Fork" button, and go through the process of creating your fork of `sentry-python`. + +### Clone the Forked Repo + +You should now have a new `sentry-python` repo in your GitHub projects. Clone it to work on it locally: ```bash -git clone git@github.com:getsentry/sentry-python.git +git clone git@github.com:/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 release. +Replace `` with your actual GitHub username. Alternatively, you can go to your GitHub profile, find the forked `sentry-python` repo, and copy the clone URL from there. + +### 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 @@ -39,15 +54,17 @@ python -m venv .venv 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. ```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. @@ -63,7 +80,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 @@ -83,101 +100,91 @@ pytest -rs tests/integrations/flask/ # Replace "flask" with the specific integr **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) +## Adding a New Integration -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" - -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) +1. Write the 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. + - 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. -There are always two persons involved in a release. + - Everybody monkeypatches. That means: -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. + - Make sure to think about conflicts with other monkeypatches when monkeypatching. -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! + - You don't need to feel bad about it. -There is a sequence diagram visualizing all this in the [README.md](https://github.com/getsentry/publish) of the `Publish` repository. + - Avoid modifying the hub, registering a new client or the like. The user drives the client, and the client owns integrations. -### Versioning Policy + - 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). -This project follows [semver](https://semver.org/), with three additions: +2. Write tests. -- 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. + - Think about the minimum versions supported, and test each version in a separate env in `tox.ini`. -- All undocumented APIs are considered internal. They are not part of this contract. + - Create a new folder in `tests/integrations/`, with an `__init__` file that skips the entire suite if the package is not installed. -- 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. +3. Update package metadata. -We recommend to pin your version requirements against `1.x.*` or `1.x.y`. -Either one of the following is fine: + - 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. -``` -sentry-sdk>=1.0.0,<2.0.0 -sentry-sdk==1.5.0 -``` + 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. -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. +4. Write the [docs](https://github.com/getsentry/sentry-docs). Follow the structure of [existing integration docs](https://docs.sentry.io/platforms/python/integrations/). Make sure to add your integration to the table in `python/integrations/index.md` (people forget to do that all the time). -## Adding a new integration (checklist) +5. Merge docs after new version has been released (auto-deploys on merge). -1. Write the integration. +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. - - 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. +## Commit Message Format Guidelines - - Everybody monkeypatches. That means: +See the documentation on commit messages here: - - Make sure to think about conflicts with other monkeypatches when monkeypatching. +https://develop.sentry.dev/commit-messages/#commit-message-format - - 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, 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 `..` 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. From 9cfb61b644700c7bfc445480800a727d415f34ad Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 4 Oct 2023 11:13:47 +0200 Subject: [PATCH 02/10] wording --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4716e87706..ffe44d59e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,7 +56,7 @@ source .venv/bin/activate ### 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. +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 . From 54931541f6255c4e73bd8232e21b7c06bad7508f Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 4 Oct 2023 11:14:46 +0200 Subject: [PATCH 03/10] more wording --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ffe44d59e2..c8dffe9f07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to Sentry SDK for Python -Thank you for your interest in contributing to `sentry-python`! +We welcome contributions to `sentry-python` by the community. 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. From e2974c4bd8308c0345199c92d31f8eab264a7078 Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 4 Oct 2023 15:21:47 +0200 Subject: [PATCH 04/10] add a note to monkeypatching --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8dffe9f07..d2f00baa83 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -112,6 +112,8 @@ pytest -rs tests/integrations/flask/ # Replace "flask" with the specific integr - You don't need to feel bad about it. + - 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. + - Avoid modifying the hub, registering a new client or the like. The user drives the client, and the client owns integrations. - 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). From 8fe442d32026d94fcf64e7488f2d6e8bcd3cf14b Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 4 Oct 2023 15:46:10 +0200 Subject: [PATCH 05/10] Update CONTRIBUTING.md Co-authored-by: Michi Hoffmann --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2f00baa83..957b78dec8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -98,7 +98,7 @@ 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) +**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) ## Adding a New Integration From a15722f6a929e0f2b39052aa779725d8510e3be5 Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 4 Oct 2023 15:58:41 +0200 Subject: [PATCH 06/10] Apply suggestions from code review Co-authored-by: Daniel Szoke Co-authored-by: Michi Hoffmann --- CONTRIBUTING.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 957b78dec8..c084d23463 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,16 +6,15 @@ This file outlines the process to contribute to the SDK itself. For contributing ## How to Report a Problem -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! +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! -If you feel that you can fix or implement it yourself, please read a few paragraphs below to learn how to submit your 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! @@ -120,7 +119,7 @@ pytest -rs tests/integrations/flask/ # Replace "flask" with the specific integr 2. Write tests. - - Think about the minimum versions supported, and test each version in a separate env in `tox.ini`. + - Consider the minimum versions supported, and test each version in a separate env in `tox.ini`. - Create a new folder in `tests/integrations/`, with an `__init__` file that skips the entire suite if the package is not installed. @@ -128,13 +127,13 @@ pytest -rs tests/integrations/flask/ # Replace "flask" with the specific integr - 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. - 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. + 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. -4. Write the [docs](https://github.com/getsentry/sentry-docs). Follow the structure of [existing integration docs](https://docs.sentry.io/platforms/python/integrations/). Make sure to add your integration to the table in `python/integrations/index.md` (people forget to do that all the time). +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 🙂). 5. Merge docs after new version has been released (auto-deploys on merge). -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. +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. ## Commit Message Format Guidelines @@ -155,7 +154,7 @@ _(only relevant for Sentry employees)_ ### Manual Process - On GitHub in the `sentry-python` repository, go to "Actions" and select the "Release" workflow. -- Click on "Run workflow" on the right side, make sure the `master` branch is selected. +- 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". From 1e1a1e066f187377e46622873b7c7af818b90f09 Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 4 Oct 2023 16:08:42 +0200 Subject: [PATCH 07/10] apply suggestions --- CONTRIBUTING.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c084d23463..d996f6a2ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,17 +28,9 @@ On macOS, we recommend using `brew` to install Python. For Windows, we recommend ### Fork the Repo -Go to the [home page of the repo](https://github.com/getsentry/sentry-python), click the "Fork" button, and go through the process of creating your fork of `sentry-python`. +Before you can contribute, you will need to [fork the `sentry-python` repository](https://github.com/getsentry/sentry-python/fork). -### Clone the Forked Repo - -You should now have a new `sentry-python` repo in your GitHub projects. Clone it to work on it locally: - -```bash -git clone git@github.com:/sentry-python.git -``` - -Replace `` with your actual GitHub username. Alternatively, you can go to your GitHub profile, find the forked `sentry-python` repo, and copy the clone URL from there. +Then, clone the forked repository to your local development environment. ### Create a Virtual Environment @@ -49,7 +41,12 @@ used by your operation system, create a virtual environment: cd sentry-python python -m venv .venv +``` +From now on, every time you want to work on your changes for `sentry-python`, +you will need to make sure your virtual environment is active: + +```bash source .venv/bin/activate ``` @@ -115,7 +112,7 @@ pytest -rs tests/integrations/flask/ # Replace "flask" with the specific integr - Avoid modifying the hub, registering a new client or the like. The user drives the client, and the client owns integrations. - - 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). + - 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). 2. Write tests. @@ -131,7 +128,7 @@ pytest -rs tests/integrations/flask/ # Replace "flask" with the specific integr 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 🙂). -5. Merge docs after new version has been released (auto-deploys on merge). +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. 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. From c5fd5748740f877819d91a80fe6c181939e8a7e6 Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 4 Oct 2023 16:14:34 +0200 Subject: [PATCH 08/10] remove the commit msg guidelines section --- CONTRIBUTING.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d996f6a2ce..067c3e6194 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -132,12 +132,6 @@ pytest -rs tests/integrations/flask/ # Replace "flask" with the specific integr 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. -## Commit Message Format Guidelines - -See the documentation on commit messages here: - -https://develop.sentry.dev/commit-messages/#commit-message-format - ## Releasing a New Version _(only relevant for Sentry employees)_ From cc9799f91e9e84e4b342af72127c9ab8493449fb Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 4 Oct 2023 16:24:17 +0200 Subject: [PATCH 09/10] Update CONTRIBUTING.md Co-authored-by: Daniel Szoke --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 067c3e6194..9d256db02c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,8 +43,7 @@ cd sentry-python python -m venv .venv ``` -From now on, every time you want to work on your changes for `sentry-python`, -you will need to make sure your virtual environment is active: +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 From 25a9b273c8d153298f6b872b28389ab04daf0f42 Mon Sep 17 00:00:00 2001 From: Ivana Kellyerova Date: Wed, 4 Oct 2023 16:25:28 +0200 Subject: [PATCH 10/10] apply suggestion --- CONTRIBUTING.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d256db02c..eca35206bc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,11 +26,9 @@ Make sure that you have Python 3 installed. Version 3.7 or higher is required to On macOS, we recommend using `brew` to install Python. For Windows, we recommend an official [python.org](https://www.python.org/downloads/) release. -### Fork the Repo +### Fork and Clone the Repo -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. +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