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.

Sign up for GitHub

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

Jump to bottom

Add PR Template #5

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add PR Template #5

wants to merge 2 commits into from

Conversation

razo7
Copy link
Member

@razo7 razo7 commented Dec 29, 2022

No description provided.

bennypowers
bennypowers requested changes Dec 29, 2022
View reviewed changes
Copy link
Member

@bennypowers bennypowers left a comment •
edited
Loading

Choose a reason for hiding this comment

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

GitHub pr templates are limited. IMO it's best to keep them small. In particular, the "related issues" portion conflicts with magic words like "fixes" or "closes"

@TomerFi
Copy link
Member

TomerFi commented Dec 29, 2022

GitHub pr templates are limited. IMO it's best to keep them small. In particular, the "related issues" portion conflicts with magic words like "fixes" or "closes"

@bennypowers the line goes:

**Related issue (if any):** fixes #issue_number_goes_here

If you replace the issue_number_goes_here with an issue number when you open the PR, the issue will be linked based on fixes keyword.
Maybe we can rephrase this rather than removing it.

@TomerFi
Copy link
Member

TomerFi commented Jan 8, 2023

@bennypowers WDYT?
rephrasing or removing?

bennypowers
bennypowers requested changes Feb 13, 2023
View reviewed changes
PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
<!-- markdownlint-disable MD041-->
## Description
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Description
## What I did

Copy link
Member

Choose a reason for hiding this comment

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

this prompt is more explicit, and encourages the author to say what they did

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bennypowers bennypowers bennypowers requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@razo7 @TomerFi @bennypowers