Skip to content

Commit 3588010

Browse files
docs(readme): add automated release notes system section
- Document the automated release notes generation capabilities - Explain benefits for contributors and maintainers - Include guidance on conventional commits and PR templates - Link to comprehensive documentation - Highlight system integration with CI/CD pipeline
1 parent b4328dd commit 3588010

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,22 @@ Pass `--git` to automatically run `git init`, create an initial commit, and (if
466466
### Lint & Format
467467
Generates ESLint + Prettier base configs at the root. Extend rules per service if needed.
468468

469+
### Release Notes Automation
470+
471+
This project uses an automated release notes generation system that:
472+
473+
- **Automatically categorizes commits** by type (features, bug fixes, breaking changes, etc.)
474+
- **Generates structured release notes** when new versions are published
475+
- **Provides templates** for consistent release documentation
476+
- **Integrates with the CI/CD pipeline** for seamless releases
477+
478+
Contributors can help improve release notes by:
479+
- Using [Conventional Commits](https://www.conventionalcommits.org/) format
480+
- Filling out PR templates with appropriate categorization
481+
- Including clear descriptions of user-facing changes
482+
483+
See [`docs/automated-release-notes.md`](docs/automated-release-notes.md) for detailed documentation.
484+
469485
### Roadmap / Ideas
470486
- Plugin hook execution pipeline
471487
- Healthchecks and depends_on in `compose.yaml`

0 commit comments

Comments
 (0)