From 1506ba9174ec44c7d0b79b27e51a23ec7cb04719 Mon Sep 17 00:00:00 2001 From: s1gr1d <32902192+s1gr1d@users.noreply.github.com> Date: Fri, 23 Oct 2026 15:14:14 +0200 Subject: [PATCH 1/3] docs: Update contribution guidelines --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- CONTRIBUTING.md | 33 +++++++++++++++++++++----------- 2 files changed, 24 insertions(+), 13 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fd24adc2207a..f87593aca2b8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,8 @@ Before submitting a pull request, please take a look at our -[Contributing](https://github.com/getsentry/sentry-javascript/blob/master/CONTRIBUTING.md) guidelines and verify: +[Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md) guidelines and verify: - [ ] If you've added code that should be tested, please add tests. - [ ] Ensure your code lints and the test suite passes (`pnpm run lint`) & (`pnpm run test`). -- [ ] Link an issue if there is one related to your pull request. If no issue is linked, one will be auto-generated and linked. +- [ ] Link the related issue. External contributors: a maintainer must have agreed on the approach in that issue. Closes #issue_link_here diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 951352e7be99..89cf4d77b22e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,11 +6,11 @@ # Contributing -We welcome suggested improvements and bug fixes to the `@sentry/*` family of packages, in the form of pull requests on -[`GitHub`](https://github.com/getsentry/sentry-javascript). The guide below will help you get started, but if you have -further questions, please feel free to reach out on [Discord](https://discord.gg/Ww9hbqr). To learn about some general -SDK development principles check out the [SDK Development Guide](https://develop.sentry.dev/sdk/) in the Sentry -Developer Documentation. +We welcome suggested improvements and bug fixes to the `@sentry/*` family of packages. If you're not on the Sentry team, read +[External Contributors](#external-contributors) before you open a pull request. The guide below will help you get +started, but if you have further questions, please feel free to reach out on [Discord](https://discord.gg/Ww9hbqr). To +learn about some general SDK development principles check out the +[SDK Development Guide](https://develop.sentry.dev/sdk/) in the Sentry Developer Documentation. ## Setting up an Environment @@ -167,15 +167,26 @@ Note: you must run `pnpm run build` before `pnpm run lint` will work. ## External Contributors -We highly appreciate external contributions to the SDK. If you want to contribute something, you can just open a PR -against `develop`. +Before you write code, agree on the approach with us in an issue. That way, you don't spend time on a PR we can't merge. -The SDK team will check out your PR shortly! +1. Find or open an issue for your change. Describe the problem and the fix you have in mind. +2. Wait for a maintainer to agree on the approach. +3. If someone else is assigned to the issue, ask them in the issue before you start. +4. Open a PR against `develop` and link the issue, for example `Fixes #1234`. -When contributing to the codebase, please note: +This also applies to small changes. We may close PRs that have no agreed approach. -- Make sure to follow the [Commit, Issue & PR guidelines](./docs/commit-issue-pr-guidelines.md) -- Non-trivial PRs will not be accepted without tests (see above). +### Using AI Tools + +Use any tools you like, but read, test, and understand every change before you submit it. +We close PRs that look like unreviewed agent output. + +### Before Opening a PR + +- Follow the [Commit, Issue & PR guidelines](./docs/commit-issue-pr-guidelines.md). +- Add tests for non-trivial changes (see [Adding Tests](#adding-tests)). +- Keep each PR to one change. Put unrelated refactors in a separate PR. +- Run `pnpm run lint` and the tests for the packages you changed. ## Commit, Issue & PR guidelines From f6cde2844886783b9db96e77aec4aab662d5bcd9 Mon Sep 17 00:00:00 2001 From: s1gr1d <32902192+s1gr1d@users.noreply.github.com> Date: Fri, 23 Oct 2026 15:43:04 +0200 Subject: [PATCH 2/3] docs: Ask external contributors for a go-ahead before opening PRs --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 28 +++++++++++++++------------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f87593aca2b8..c935a1665d3c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,6 +3,6 @@ Before submitting a pull request, please take a look at our - [ ] If you've added code that should be tested, please add tests. - [ ] Ensure your code lints and the test suite passes (`pnpm run lint`) & (`pnpm run test`). -- [ ] Link the related issue. External contributors: a maintainer must have agreed on the approach in that issue. +- [ ] Link the related issue. External contributors need a maintainer's go-ahead in that issue. Closes #issue_link_here diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89cf4d77b22e..66c70381153a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,10 +6,10 @@ # Contributing -We welcome suggested improvements and bug fixes to the `@sentry/*` family of packages. If you're not on the Sentry team, read -[External Contributors](#external-contributors) before you open a pull request. The guide below will help you get -started, but if you have further questions, please feel free to reach out on [Discord](https://discord.gg/Ww9hbqr). To -learn about some general SDK development principles check out the +We welcome suggested improvements and bug fixes to the `@sentry/*` family of packages. If you're not on the Sentry +team, read [External contributors](#external-contributors) before you open a pull request. The guide below will help +you get started, but if you have further questions, please feel free to reach out on +[Discord](https://discord.gg/Ww9hbqr). To learn about some general SDK development principles check out the [SDK Development Guide](https://develop.sentry.dev/sdk/) in the Sentry Developer Documentation. ## Setting up an Environment @@ -165,23 +165,25 @@ Similar to building and testing, linting can be done in the project root or in i Note: you must run `pnpm run build` before `pnpm run lint` will work. -## External Contributors +## External contributors -Before you write code, agree on the approach with us in an issue. That way, you don't spend time on a PR we can't merge. +Before you write code, get a maintainer's go-ahead in an issue. That way, nobody spends a weekend on a PR that just +sits in our queue. We check that the change fits our plans and that we have time to review it. Code details can wait +for the PR review. -1. Find or open an issue for your change. Describe the problem and the fix you have in mind. -2. Wait for a maintainer to agree on the approach. +1. Find or open an issue for your change. Describe the problem and what you want to change. +2. Wait for a maintainer to give you the go-ahead. 3. If someone else is assigned to the issue, ask them in the issue before you start. 4. Open a PR against `develop` and link the issue, for example `Fixes #1234`. -This also applies to small changes. We may close PRs that have no agreed approach. +This also applies to small changes, typo fixes included. We may close PRs without a go-ahead. -### Using AI Tools +### Using AI tools -Use any tools you like, but read, test, and understand every change before you submit it. -We close PRs that look like unreviewed agent output. +Use any tools you like. You're still the one who answers the review comments, so read, test, and understand every +change before you submit it. We close PRs that look like unreviewed agent output. -### Before Opening a PR +### Before you open a PR - Follow the [Commit, Issue & PR guidelines](./docs/commit-issue-pr-guidelines.md). - Add tests for non-trivial changes (see [Adding Tests](#adding-tests)). From f79945cdc3dd8b36e69e93cf9d3b83ef04ecb51d Mon Sep 17 00:00:00 2001 From: s1gr1d <32902192+s1gr1d@users.noreply.github.com> Date: Fri, 23 Oct 2026 16:25:23 +0200 Subject: [PATCH 3/3] docs: Drop typo fix wording from contribution guidelines --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66c70381153a..f74f514148f1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -176,7 +176,7 @@ for the PR review. 3. If someone else is assigned to the issue, ask them in the issue before you start. 4. Open a PR against `develop` and link the issue, for example `Fixes #1234`. -This also applies to small changes, typo fixes included. We may close PRs without a go-ahead. +This also applies to small changes. We may close PRs without a go-ahead. ### Using AI tools