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 PR template #495

Merged
merged 2 commits into from
Mar 29, 2021
Merged

add PR template #495

merged 2 commits into from
Mar 29, 2021

Conversation

mr-tz
Copy link
Collaborator

@mr-tz mr-tz commented Mar 23, 2021

in support of #457

Copy link
Member

@Ana06 Ana06 left a comment

Choose a reason for hiding this comment

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

thanks for taking care of this @mr-tz!


### Checklist

- [ ] I have updated the [CHANGELOG.md](/CHANGELOG.md)
Copy link
Member

Choose a reason for hiding this comment

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

Should we set up the GitHub action and a templete in the CHANGELOG to ensure this is done before adding it here? I was thinking about setting this up together with the next release to be able to start with a empty CHANGELOG.

In #457 I suggested to use a label if no CHANGELOG changes are needed. But contributors don't have permissions for that. Maybe a section like the one for the tests would be better, so that we can add the label if no changes are needed. Something like:

### Changelog

- [ ] I have updated the [CHANGELOG.md](/CHANGELOG.md)
- [ ] The [CHANGELOG.md](/CHANGELOG.md) doesn't need to be updated (changelog linter will fail until a maintainer adds the `no changelog` label)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Should we set up the GitHub action and a templete in the CHANGELOG to ensure this is done before adding it here?

  1. Adding the template is a good idea, I think the Action is optional for now.

  2. Wouldn't any change require a respective CHANGELOG entry? Let's try to keep it simple.

Copy link
Member

Choose a reason for hiding this comment

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

@mr-tz

Wouldn't any change require a respective CHANGELOG entry? Let's try to keep it simple.

We could give it a try. 🤔

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved

### Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
Copy link
Member

Choose a reason for hiding this comment

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

Checklists in PR sound like a good idea, but my experience is that in practice they are just removed because they are annoying to fill. I am up to give it a try, but I am not sure if we need a checklist for the type of change if soon it is expected that the author updates the changelog (which has this information).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I like this part to get a quick overview of what the PR provides. I've removed the actual Checklist entry.

@mr-tz mr-tz merged commit f8d2b41 into master Mar 29, 2021
@mr-tz mr-tz deleted the gh/add-pr-template branch March 29, 2021 15:31
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.

2 participants