Skip to content

Create pull_request_template.md #503

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

Merged
merged 1 commit into from
Sep 6, 2022
Merged

Create pull_request_template.md #503

merged 1 commit into from
Sep 6, 2022

Conversation

phip1611
Copy link
Member

@phip1611 phip1611 commented Sep 4, 2022

This is an initial draft for a pull request template. Any comments?

I don't know yet where we can configure this to be used as the default for new PRs. This is the first time that I create a PR template on GitHub

Apparently, GitHub automatically uses this template based on it's file name.

@phip1611 phip1611 force-pushed the pullrequest-template branch 3 times, most recently from 52fa612 to c63935e Compare September 4, 2022 20:40
@phip1611 phip1611 requested a review from a team September 4, 2022 20:40
Copy link
Member

@nicholasbishop nicholasbishop left a comment

Choose a reason for hiding this comment

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

From https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository, I think the file path should be .github/pull_request_template.md (no templates subdir).

I left a few suggestions, basically I think we can minimize this down to: is the history reasonably clean, and is the changelog updated.

@phip1611 phip1611 force-pushed the pullrequest-template branch from c63935e to dbd0a62 Compare September 5, 2022 07:40
@phip1611
Copy link
Member Author

phip1611 commented Sep 5, 2022

I simplified the template. What do you think?

@nicholasbishop
Copy link
Member

Lgtm! I assume once we merge this then PRs will automatically start showing the new template, we'll see soon :)

@phip1611
Copy link
Member Author

phip1611 commented Sep 5, 2022

Can't merge because we have to merge #502 first :D

@phip1611
Copy link
Member Author

phip1611 commented Sep 6, 2022

yikes, we should merge it via squash via the Web UI. I accidentally pushed two commits instead of one.

Otherwise, give me 5 minutes and I can also fix it by hand.

Update Done

@phip1611 phip1611 force-pushed the pullrequest-template branch from b67e1ce to 18d9b63 Compare September 6, 2022 15:26
@phip1611 phip1611 merged commit 65418c7 into main Sep 6, 2022
@phip1611 phip1611 deleted the pullrequest-template branch September 6, 2022 15:30
@phip1611
Copy link
Member Author

phip1611 commented Sep 6, 2022

It's working @GabrielMajeri @nicholasbishop :)

image

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.

3 participants