Skip to content

docs: mention the skip-changelog label #5366

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
jamescrosswell merged 1 commit into from
Jul 10, 2026
Merged

docs: mention the skip-changelog label #5366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,9 @@ Public API diffs are stored as Verify snapshot files. After any public API chang

## Changelog

- If the change is not user-facing, add `#skip-changelog` to the PR description
- Otherwise generated automatically from [Commit message conventions](https://develop.sentry.dev/engineering-practices/commit-messages/).
- Do **NOT** add changelogs manually.
- If the change is not user-facing, either write `#skip-changelog` to the PR description or add the `skip-changelog` label to the PR
- Otherwise generated automatically from [Commit message conventions](https://develop.sentry.dev/engineering-practices/commit-messages/)
- Do **NOT** add changelogs manually

```sh
# Get PR number for current branch
Expand Down Expand Up @@ -171,4 +171,4 @@ Prefer LSP over Grep/Read for code navigation — it's faster, precise, and avoi

Use Grep only when LSP isn't available or for text/pattern searches (comments, strings, config).

After writing or editing code, check LSP diagnostics and fix errors before proceeding.
After writing or editing code, check LSP diagnostics and fix errors before proceeding.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,9 @@ Below that, you'll add heading 3 mentioned above. For example, if you're adding
- Attach screenshots when capturing errors on WPF (#PR number)
```

There's a GitHub action check to verify if an entry was added. If the entry isn't a user-facing change, you can skip the verification with `#skip-changelog` written to the PR description. The bot writes a comment in the PR with a suggestion entry to the changelog based on the PR title.
There's a GitHub action check to verify if an entry was added.
If the entry isn't a user-facing change, you can skip the verification with either `#skip-changelog` written to the PR description or the `skip-changelog` label added to the PR.
The bot writes a comment in the PR with a suggestion entry to the changelog based on the PR title.

## Naming tests

Expand Down
Loading