docs: clarify changelog fragment workflow - #32046
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Deployment failed with the following error: Learn More: https://vercel.com/docs/concepts/projects/project-configuration |
|
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Have you signed the CLA already but the status is still pending? Recheck it. |
There was a problem hiding this comment.
Pull request overview
This PR clarifies the contributor-facing workflow for changelog fragments and how those fragments relate to the root CHANGELOG.md, including when pr/no-changelog is appropriate and adding a changelog checkpoint to the PR template.
Changes:
- Expanded
CONTRIBUTING.mdguidance on when to add a changelog fragment, expected categories, and whyCHANGELOG.mdshould not be edited directly. - Added contributor-focused workflow documentation to
changelog/README.md, including notes about fragment collection intoCHANGELOG.md. - Updated the PR template to include a changelog checklist item and a pointer to the changelog guidance.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Documents when/why to add changelog fragments, categories, and how fragments feed CHANGELOG.md. |
| changelog/README.md | Adds a “Contributor workflow” section explaining fragment expectations and release aggregation. |
| .github/pull_request_template.md | Adds a changelog checklist item linking to the contributor guidance. |
Description
Clarifies the relationship between changelog fragments and the root
CHANGELOG.mdfor contributors. This change documents:pr/no-changelogis appropriate;Closes #32030.
Changelog
pr/no-changeloglabel.Testing
git diff HEAD^ --check.github/workflows/changelog-checker.yml.PCI review checklist