fix: Add a changelog policy for TeachLink Web - #1614
Merged
Merged
Conversation
|
@Wittig18 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Wittig18
marked this pull request as ready for review
September 26, 2026 09:03
Contributor
|
Thank you for contributing to the project |
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
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.
Summary
Added the missing changelog governance document and a regression test, closing the governance gap described in issue #1538.
Files added (2, both inside
Governance/):Governance/policies/CHANGELOG_POLICY.md— a new policy document following the house style of the otherGovernance/policies/*.mdfiles (title, Purpose, Scope, body sections, Ownership, Success). It documents:CHANGELOG.md, one## [MAJOR.MINOR.PATCH] - YYYY-MM-DDsection per release, newest-first ordering, an## [Unreleased]section on top, one single-line past-tense entry per change, linked issue/PR references,**Breaking:**callouts with migration guidance, and security entries that respect the disclosure process.VERSIONING.md,DEPRECATION.md,RELEASE_CHECKLIST.md,VULN_DISCLOSURE.md, andRFC_PROCESS.md.Governance/policies/CHANGELOG_POLICY.test.ts— vitest regression tests (matching the existingDEPRECATION.test.ts/RELEASE_CHECKLIST.test.tsconvention) that read the checked-in document and assert its canonical section list, the three required areas, absence of placeholders, the 82-column line-width convention, the format guarantees, the full category list, the entry-requirement rules, and that every referenced governance document actually exists on disk.No existing files were modified, no functionality was touched, and no changes were made outside
Governance/.Changed files
Governance/policies/CHANGELOG_POLICY.mdGovernance/policies/CHANGELOG_POLICY.test.tsTest plan
CI runs the repository's vitest suite. The new
Governance/policies/CHANGELOG_POLICY.test.tswill be discovered by the existing vitest config (same pattern as the siblingGovernance/policies/DEPRECATION.test.tsandGovernance/templates/RELEASE_CHECKLIST.test.ts). Expected: all new tests pass — document structure, format guarantees, category list, entry-requirement rules, and cross-reference existence checks. No existing tests are affected since no source files were changed. Also expecttype-check,lint, andbuildto remain green, as the only additions are a Markdown document and a self-contained test file.This PR was created as a draft by the issue solver bot. It will remain a
draft until repository CI passes.
Closes #1538