Skip to content

Commit 7d0f459

Browse files
Move changelog automation docs to contributing guide and make concise
Co-authored-by: saulshanabrook <1186124+saulshanabrook@users.noreply.github.com>
1 parent d874184 commit 7d0f459

File tree

2 files changed

+4
-36
lines changed

2 files changed

+4
-36
lines changed

.github/CHANGELOG_AUTOMATION.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

docs/reference/contributing.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,10 @@ or bug fixes.
8484

8585
When you are ready to submit your changes, please open a pull request. The CI will run the tests and check the code style.
8686

87+
#### Changelog Automation
88+
89+
When you open a pull request, a GitHub Action automatically adds an entry to the UNRELEASED section of the changelog using your PR title and number. This ensures the changelog stays up-to-date without manual intervention.
90+
8791
## Documentation
8892

8993
We use the [Diátaxis framework](https://diataxis.fr/) to organize our documentation. The "explanation" section has

0 commit comments

Comments
 (0)