Skip to content

New PULL_REQUEST_TEMPLATE.md file #1637 - #1639

Merged
ntwb merged 1 commit into
WordPress:masterfrom
DevinWalker:add/pull-request-template.md
Sep 22, 2017
Merged

ntwb merged 1 commit into
WordPress:masterfrom
DevinWalker:add/pull-request-template.md

Conversation

@DevinWalker

Copy link
Copy Markdown
Contributor

PR Overview

Added a PULL_REQUEST_TEMPLATE.md file as a starting point. This will encourage more descriptive PRs to improve ease of testing and review.

If you have any suggested edits, just let me know!

Ref: #1637

@ntwb ntwb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also see #1637

<!-- What types of changes does your code introduce? -->
<!-- Bug fix (non-breaking change which fixes an issue) -->
<!-- New feature (non-breaking change which adds functionality) -->
<!-- Breaking change (fix or feature that would cause existing functionality to not work as expected) -->

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The above Types of Changes verbiage should match that of the existing CONTRIBUTING.md, add, try, update etc

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This section seems to be more for the actual naming of the branch. How would you suggest this is described within the changes section?

## Checklist:
- [ ] My code is tested.
- [ ] My code follows the WordPress code style.
- [ ] My code follows has proper inline documentation. No newline at end of file

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

A link to the TESTING section of CONTRIBUTING.md should be included in this section

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Same questions here. Do we really want links within the PR template? I haven't seen any other templates include links like this before. If it's not in an HTML comment you're going to see a bunch of people not remove it and clutter up the actual content.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would say don't link as it could create the issue we already have. I know it's a good information source, but we consistently have an issue with people not clearing out this content.

@@ -0,0 +1,20 @@
## Description

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Probably above this should be a link CONTRIBUTING.md

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Do you suggest that it's linked within an html comment? I think if it's not then you'll see a bunch of issues with "Please read how to contribute prior to submitting an issue" or whatever verbiage prior to the actual issue. Could get annoying.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would -1 for linking for the reasons @DevinWalker has said.


## Screenshots (jpeg or gifs if applicable):

## Types of changes

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is this really necessary? I'd rather use tags for most of these

@DevinWalker DevinWalker Jul 3, 2017 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've found screenshots to be very helpful, especially gifs, when reviewing a feature or UI fix/enhancement. Also, normal contributors don't have access to label our PRs.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Screenshots are very helpful indeed. I was talking about the "Types of changes" but the labels permissions is a good point.

@gziolo

gziolo commented Sep 21, 2017

Copy link
Copy Markdown
Member

@mtias or @karmatosed, it would be nice to get it merged. Would you mind leaving your feedback here? I'm happy to help to get it into master.

@karmatosed karmatosed left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think this should go in without changes. It's better than we have now and solves the issue.

@ntwb
ntwb merged commit a93c553 into WordPress:master Sep 22, 2017
@ntwb

ntwb commented Sep 22, 2017

Copy link
Copy Markdown
Member

Thanks again @DevinWalker, sorry it took so long 👍

@DevinWalker

DevinWalker commented Sep 22, 2017 via email

Copy link
Copy Markdown
Contributor Author

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.

5 participants