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

Add release notes to the repo #1966

Open
xaur opened this issue Jan 22, 2021 · 0 comments
Open

Add release notes to the repo #1966

xaur opened this issue Jan 22, 2021 · 0 comments

Comments

@xaur
Copy link

xaur commented Jan 22, 2021

Storing release notes in the repository has the following advantages compared to using GitHub releases as a source of truth:

  • makes the Git repo more self-contained and not depending on GitHub
  • allows using Git/GitHub collaborative tools for the text
  • provides easy access to raw markdown (e.g. when compiling the multi-project release notes)

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

See dcrpool, dcrd or vspd as examples of adopting this convention.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@xaur