Skip to content

refactor: remove requirement for redundant explicit changelog - #187

Open
Kelketek wants to merge 1 commit into
tari-project:mainfrom
Kelketek:fox/remove-redundant-changelogs
Open

refactor: remove requirement for redundant explicit changelog#187
Kelketek wants to merge 1 commit into
tari-project:mainfrom
Kelketek:fox/remove-redundant-changelogs

Conversation

@Kelketek

Copy link
Copy Markdown
Contributor

Description

This change removes the requirement for explicit written changelogs in TIPs.

Motivation and Context

These changelogs are redundant since commit logs already exist, and a button has now been added to every page on the RFCs site to view the history directly. These changelogs created an extra task to remember, easily forgotten, which could give the wrong impression of a document's history.

Individual TIPs may elect to retain their changelog by the teams using them -- this only removes the requirement.

One potential drawback is that some history could be compressed for certain documents. For instance, before a TIP is merged, changes within a PR might be removed from the history as it's all bundled into one commit upon merge. However, in those cases, the changes would never have been in effect, and the pull request is still available for review if it is truly needed.

How Has This Been Tested?

Locally via render

@Kelketek
Kelketek force-pushed the fox/remove-redundant-changelogs branch from 210e2f9 to c486b64 Compare July 15, 2026 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants