Skip to content

Add ADR for use of CHANGELOG file#23

Closed
edavey wants to merge 2 commits into
mainfrom
add-adr-for-changelog
Closed

Add ADR for use of CHANGELOG file#23
edavey wants to merge 2 commits into
mainfrom
add-adr-for-changelog

Conversation

@edavey
Copy link
Copy Markdown
Collaborator

@edavey edavey commented Sep 3, 2025

No description provided.

@edavey edavey requested a review from pezholio September 3, 2025 07:37
@edavey edavey force-pushed the add-adr-for-changelog branch from 6d63098 to e8f1b3c Compare September 3, 2025 12:59
@edavey
Copy link
Copy Markdown
Collaborator Author

edavey commented Sep 3, 2025

@pezholio are you in agreement with using a CHANGELOG? If so I was planning to include some Govspeak notes in the commit message where I update the changelog for #19

@pezholio
Copy link
Copy Markdown
Contributor

pezholio commented Sep 3, 2025

I'm on the fence about this for a couple of reasons:

  1. We don't want to make this overly onerous
  2. Equally, if we do want to do this - we don't want it to be something that can easily be ignored
  3. As we're continuously deploying, it'll more than likely be one Changelog entry per release, which might be counterintuitive

Interested to hear your thoughts 👍

@edavey
Copy link
Copy Markdown
Collaborator Author

edavey commented Sep 3, 2025

I'm on the fence about this for a couple of reasons:

  1. We don't want to make this overly onerous
  2. Equally, if we do want to do this - we don't want it to be something that can easily be ignored
  3. As we're continuously deploying, it'll more than likely be one Changelog entry per release, which might be counterintuitive

Interested to hear your thoughts 👍

hmm... I'm in favour of:

  • continuous deployment for minimising risk, and am in favour of
  • the discipline of having a changelog entry with each bugfix or feature merge

I'm not sure how to combine the two, but I expect a bit of research will throw some light on it.

For now I will find another way of adding the Govspeak documentation I want to record.

@edavey
Copy link
Copy Markdown
Collaborator Author

edavey commented Sep 3, 2025

closing for now

@edavey edavey closed this Sep 3, 2025
@pezholio
Copy link
Copy Markdown
Contributor

pezholio commented Sep 3, 2025

Yeah, definitely. I think there's something here, but I wonder if there's something less rigid than a Changelog that we can implement

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