docs: contributing guideline#4347
Open
aldy505 wants to merge 2 commits into
Open
Conversation
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
aminvakil
reviewed
May 23, 2026
Collaborator
aminvakil
left a comment
aminvakil
left a comment
There was a problem hiding this comment.
Except .env.custom all are nitpicking really.
|
|
||
| ## What to contribute | ||
|
|
||
| Hi! I'm Reinaldy (aldy505). I view self-hosted Sentry not just as something we maintain, but as a community we develop together. Contributing to self-hosted means more than code contributions; there are many ways to help! |
Collaborator
There was a problem hiding this comment.
I don't think it's appropriate to mention your name on CONTRIBUTING.md of a organization project honestly :) But that's just me, as I just haven't seen it anywhere before. If you feel this is more welcoming, ignore this.
Suggested change
| Hi! I'm Reinaldy (aldy505). I view self-hosted Sentry not just as something we maintain, but as a community we develop together. Contributing to self-hosted means more than code contributions; there are many ways to help! | |
| Hi! We view self-hosted Sentry not just as something we maintain, but as a community we develop together. Contributing to self-hosted means more than code contributions; there are many ways to help! |
| Generated and managed config files live in the repo working tree: | ||
|
|
||
| - `.env` is the default environment file. | ||
| - `.env.custom` is loaded automatically when present and should be your normal place for local overrides. |
Collaborator
There was a problem hiding this comment.
This does not get picked up by docker compose automatically, you should use something like this for it to get passed to containers:
docker compose --env-file .env --env-file .env.custom up --wait
| There are two kinds of tests: | ||
|
|
||
| 1. Unit tests: run specific bash scripts and ensure they're working as intended. Test files are under the `_unit-test/` directory, and assertions are made using Bash. | ||
| 2. Integration tests: run the entire self-hosted stack (using specific `COMPOSE_PROFILES`) by running `./install.sh` and `docker compose up -d`, then execute scenarios for logging in and verifying that events are ingested and queried correctly. Test files are under `_integration-test/`, and assertions are written in Python using the `pytest` testing framework. |
Collaborator
There was a problem hiding this comment.
I'd suggest using docker compose up --wait everywhere to be consistent with install.sh messages.
Suggested change
| 2. Integration tests: run the entire self-hosted stack (using specific `COMPOSE_PROFILES`) by running `./install.sh` and `docker compose up -d`, then execute scenarios for logging in and verifying that events are ingested and queried correctly. Test files are under `_integration-test/`, and assertions are written in Python using the `pytest` testing framework. | |
| 2. Integration tests: run the entire self-hosted stack (using specific `COMPOSE_PROFILES`) by running `./install.sh` and `docker compose up --wait`, then execute scenarios for logging in and verifying that events are ingested and queried correctly. Test files are under `_integration-test/`, and assertions are written in Python using the `pytest` testing framework. |
| - Call out any generated files, config migrations, or operator-visible behavior changes. | ||
| - Include the exact validation you ran locally. | ||
| - Link upstream issues or PRs when the root cause is outside this repository. | ||
| - Keep commit history readable. A small number of focused commits is better than a long stream of fixups. |
Collaborator
There was a problem hiding this comment.
I want to add "Take it easy though, focus on your development instead of commits" somehow, but I cannot think of a good sentence.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.