Skip to content
This repository was archived by the owner on Sep 15, 2025. It is now read-only.

Add changelog entry about changelog itself #546

Merged
mokagio merged 1 commit into from
Oct 18, 2022
Merged

Add changelog entry about changelog itself #546

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ _None._

### Internal Changes

_None._
- Add this changelog file. [#545]
Copy link
Contributor Author

@mokagio mokagio Oct 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I debated wether to use the full URL, which is more friendly to being used outside of GitHub, where the rendered wouldn't expand #number to a PR URL.

Suggested change
- Add this changelog file. [#545]
- Add this changelog file. [#545](https://github.com/wordpress-mobile/WordPressKit-iOS/pull/545)

I decided against it because:

  • We don't do that in other projects
  • Using the number alone is simpler
  • What are the chances of actually needing these raw changelog notes elsewhere? (If we'll ever need them, it's straightforward to add a parsing step to introduce the full URLs ourselves).

Copy link
Contributor

@AliSoftware AliSoftware Oct 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I remember similarly debating about that when I started the CHANGELOG.md in release-toolkit. And sometimes I miss the fact that those are not clickable (while in RELEASE-NOTES.txt file we use in our client app's projects, contributors do add the URL).

But ultimately I agree that it's simpler to just add the PR number alone, reduces the risk of accidental inconsistency (with a bad copy/paste where we'd change the PR number but forgot to update the URL…). And in the seldom cases where we do need to look at the associated PR for a changelog entry, which is not that frequent to be a burden imho, it's not that much effort to enter the URL manually in your browser, so simpler to write wins for that case in my book.