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

Add checklist for PRs #1601

Merged
merged 2 commits into from
Jun 17, 2021
Merged

Add checklist for PRs #1601

merged 2 commits into from
Jun 17, 2021

Conversation

akshaymankar
Copy link
Member

Hopefully this helps us create a nicer experience for reviewers and people who cut releases.

Copy link
Contributor

@pcapriotti pcapriotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@mdimjasevic
Copy link
Contributor

I didn't quite get the part about components and endpoints. I am not sure if that checkbox addresses it, but perhaps it would be worthwhile to have separate changelog considerations for external and internal endpoints.

@akshaymankar
Copy link
Member Author

I didn't quite get the part about components and endpoints.

So, if one creates a new internal endpoint in galley and consume it in brig. Now, it needs to be ensured that galley gets deployed before brig. This is because we cannot, as of now, guarantee that a new brig will only call new galley. To make sure this information doesn't get lost, we should write it down in the changelog.

I am not sure if that checkbox addresses it, but perhaps it would be worthwhile to have separate changelog considerations for external and internal endpoints.

Yeah, this is not ensured by the checkbox. IMO changes to internal APIs don't really need to be put in the changelog, as consumers of this changelog don't really care.

.github/pull_request_template.md Show resolved Hide resolved
Co-authored-by: jschaul <jschaul@users.noreply.github.com>
@akshaymankar akshaymankar merged commit 253606a into develop Jun 17, 2021
@akshaymankar akshaymankar deleted the akshaymankar/checklist branch June 17, 2021 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants