Consider adding a "What's New" section in readme #792
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
Signed-off-by: Stephanie Chong <168800785+Steph-Chong@users.noreply.github.com>
Signed-off-by: Stephanie Chong <168800785+Steph-Chong@users.noreply.github.com>
Signed-off-by: Stephanie Chong <168800785+Steph-Chong@users.noreply.github.com>
Signed-off-by: Stephanie Chong <168800785+Steph-Chong@users.noreply.github.com>
Signed-off-by: Stephanie Chong <168800785+Steph-Chong@users.noreply.github.com>
|
You can see what this looks like on GitHub here: https://github.com/Steph-Chong/scores/tree/New-What's-New-section-in-README Below is a screenshot from when I built it locally in Read the Docs: |
Steph-Chong
changed the title
|
I'm happy for this to be added if @tennlee is. It may be worth adding in somewhere in the maintainer notes that this needs to be updated with each release so that we don't forget to update it. |
Yes, if it does get added, I agree the need to update it with each release should definitely be added to the maintainer's notes! |
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.
@nicholasloveday @tennlee
What do you think about adding a "What's New" link towards the top of the README.md, with a link to the release notes?
If this isn't wanted, no worries, I will close this PR.
But if it is wanted, then I think it could be particularly useful to have for the 2.0.0 release (given that will be a major release).