Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Store release notes in the repository #482

Open
xaur opened this issue Jun 5, 2020 · 2 comments
Open

Store release notes in the repository #482

xaur opened this issue Jun 5, 2020 · 2 comments
Labels
enhancement New feature or request

Comments

@xaur
Copy link

xaur commented Jun 5, 2020

It is a good idea to store release notes in the repository of the project. Compared to using other locations as a source of truth for release notes (GitHub releases, Reddit, Google Play, Apple Store), not only this allows using Git/GitHub collaborative tools for text, it also makes the Git repo more self-contained and not depending on those external locations.

The best practice I've encountered is to put a separate file in docs/release-notes for each new release.

(cross-posting from dcrpool repo)
@dreacot
Copy link
Contributor

dreacot commented Sep 21, 2021

@monsa00 can we have this done?

@dreacot dreacot added bug Something isn't working enhancement New feature or request and removed bug Something isn't working labels Sep 24, 2021
@xaur
Copy link
Author

xaur commented Oct 10, 2021

Google Play Store page already shows user-friendly release highlights in the "What's New" section. This could be used as a summary/intro paragraph in release notes for each release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@xaur @dreacot