Added a Changelog #1690
Merged
Added a Changelog #1690
Conversation
This file contains 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
ADBond
added
documentation
Thought it would be useful to have a reference to a full release, and this version was quite a small change
RossKen
approved these changes
Nov 2, 2023
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.
Type of PR
Is your Pull Request linked to an existing Issue or Pull Request?
Adding a changelog as I had previously mooted
Give a brief description for the solution you have provided
Apologies, I accidentally committed the first couple of changes to
master, so the 'proper' diff of this PR including those is here - feel free to also make comments on those initial points.Have updated the PR template + release guide to include the workflow additions.
I think I have reasonably captured our current unreleased changes, but let me know if there are any mistakes / omissions.
I have also back-filled notes for 3.9.8 to help show what the general format looks like, as it was a pretty small release.
Additionally I deliberately decided not to include updates to the docs (or other things such as adding this changelog), as these are not really tied to a particular release (as they go live as soon as they're merged), and so I don't think from a user persepective of 'what functionality is different if I pip install X version' it is really relevant. Happy for any discussion on this point though.
PR Checklist