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.

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

Update PR template changelog checklist #1089

Merged
merged 1 commit into from
Nov 15, 2022
Merged

Conversation

joverlee521
Copy link
Contributor

Creating this PR for discussion around the idea that we should keep the changelog as end user focused changes only.

Motivated by @tsibley's recent comment:

a changelog for something like Augur is (IMO) best viewed/used as a document for end users.

Update the language to reflect that entries in the changelog should
only be end user focused changes. Motived by @tsibley's comment¹ in a
recent PR.

It's nice for external users if our changelog is not bloated by
internal development changes!

¹ #1039 (comment)
@joverlee521
Copy link
Contributor Author

I personally also think it's nice for external users if the changelog is not bloated by internal dev changes, but would like to hear other's opinions here!

@joverlee521 joverlee521 requested a review from a team November 4, 2022 22:55
@joverlee521 joverlee521 mentioned this pull request Nov 4, 2022
1 task
@joverlee521 joverlee521 merged commit 1551cd1 into master Nov 15, 2022
@joverlee521 joverlee521 deleted the user-focused-changelog branch November 15, 2022 22:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

3 participants