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

The github PR template is out of date #2783

Open
pygy opened this issue Jun 9, 2022 · 2 comments
Open

The github PR template is out of date #2783

pygy opened this issue Jun 9, 2022 · 2 comments
Assignees
Labels
Type: Bug For bugs and any other unexpected breakage

Comments

@pygy
Copy link
Member

pygy commented Jun 9, 2022

https://github.com/MithrilJS/mithril.js/blob/next/.github/PULL_REQUEST_TEMPLATE.md still instructs users to update the changelog, but pr-release is in charge now.

I'd remove it, but wanted to make sure that we don't need some PR formatting advice to replace it, ensuring a nice looking change log

Mithril.js version:

Browser and OS:

Project:

Code

// Code

Steps to Reproduce

Expected Behavior

Current Behavior

Context

@pygy pygy added the Type: Bug For bugs and any other unexpected breakage label Jun 9, 2022
@JAForbes
Copy link
Collaborator

JAForbes commented Jun 9, 2022

pr-release tries very hard to not require special formatting, so the contributor can do whatever they like in the feature PR description. So definitely proceed in removing it.

It will try to extract the first sentence or so of content, ignoring headers, comments and compressing lists into sentences.

@pygy
Copy link
Member Author

pygy commented Jun 9, 2022

We could perhaps use the first comment in the template to let users know that what part of the PR text will become the change log item...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug For bugs and any other unexpected breakage
Projects
None yet
Development

No branches or pull requests

3 participants