Skip to content

Commit 8547b02

Browse files
docs: Require issue discussion before PRs (#6919)
* docs: Require issue discussion before PRs Co-Authored-By: Chris Aigner <christoph.aigner@sentry.io> * docs: Say hundreds of thousands of apps Co-Authored-By: Chris Aigner <christoph.aigner@sentry.io> * docs: Ask for a regular PR instead of a draft Co-Authored-By: Chris Aigner <christoph.aigner@sentry.io> * docs: Show white Sentry logo in dark mode --------- Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com> Co-authored-by: Chris Aigner <25478494+christophaigner@users.noreply.github.com>
1 parent e5d0b91 commit 8547b02

1 file changed

Lines changed: 37 additions & 5 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,44 @@
1+
<p align="center">
2+
<a href="https://sentry.io" target="_blank">
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-white.png">
5+
<img alt="Sentry" src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
6+
</picture>
7+
</a>
8+
<br />
9+
</p>
10+
111
# Contributing
212

13+
Thanks for your interest in contributing to `sentry-react-native`! This guide explains how we work with external contributions and how to get your environment set up. If you have questions, reach out on [Discord](https://discord.com/invite/sentry).
14+
315
This repository contains mono repository structure with multiple React Native and Expo project for development and testing.
416

17+
# Submitting Changes
18+
19+
**TL;DR: Discuss your change in a GitHub issue before opening a pull request. We may close PRs that weren't discussed with a maintainer first.**
20+
21+
Every line we merge is code we maintain long-term for hundreds of thousands of apps, so we want to agree on the problem and the approach before anyone writes code. This saves time for you and for us.
22+
23+
## Before You Start
24+
25+
1. **Find or create an issue.** Search the [issue tracker](https://github.com/getsentry/sentry-react-native/issues) first. If nothing fits, open a new issue describing the problem or feature.
26+
2. **Discuss your approach with a maintainer.** Comment on the issue with what you plan to change and wait for a maintainer to respond before you start working.
27+
3. **Check the assignee.** If the issue is already assigned to someone else, coordinate with them in the issue before starting work.
28+
29+
## Making Your Contribution
30+
31+
- Fork the repo and make your changes on a branch.
32+
- Add tests. Non-trivial PRs won't be accepted without them.
33+
- Don't bump version numbers. We do that when we release.
34+
- Open a PR that links the issue (e.g. `Fixes #123`)
35+
- Name your PR according to our [commit message format](https://develop.sentry.dev/commit-messages/#commit-message-format).
36+
- Keep PRs focused: one change per PR, no unrelated refactors.
37+
38+
## AI Use
39+
40+
You are welcome to use whatever tools you prefer for making a contribution. However, any changes you propose have to be understood, reviewed and tested by you, a human, first, before you submit a pull request with them for the Sentry team to review. If we feel like that didn't happen, we will close the PR outright. For example, we won't review visibly AI-generated PRs from an agent instructed to look for and "fix" open issues in the repo. This aligns with our SDK principle: [every line has an owner](https://develop.sentry.dev/sdk/getting-started/principles/#every-line-has-an-owner).
41+
542
# Overview
643

744
- / -> monorepo root private package
@@ -231,8 +268,3 @@ includeBuild('../../../../sentry-android-gradle-plugin/plugin-build') {
231268

232269
5. The build command will wait for the debugger connection, go to the Android Studio and select the newly created `Remote JVM Debug` configuration and click `Debug`.
233270
6. The build process will stop on active breakpoint.
234-
235-
236-
# AI Use
237-
238-
You are welcome to use whatever tools you prefer for making a contribution. However, any changes you propose have to be reviewed and tested by you, a human, first, before you submit a pull request with them for the Sentry team to review. If we feel like that did not happen, we will close the PR outright. For example, we will not review visibly AI-generated PRs from an agent instructed to look for and "fix" open issues in the repo. This aligns with our SDK principle: [every line has an owner](https://develop.sentry.dev/sdk/getting-started/principles/#every-line-has-an-owner).

0 commit comments

Comments
 (0)