Advise users to retain issue/PR templates #8029

bunder2015 · 2018-10-16T10:26:57Z

Motivation and Context

Occasionally we get issues and PRs from users who delete the
templates. Advise users that their issues and PRs may be closed if
they do not fill out the templates as we really need this information.

Description

Updated templates.

How Has This Been Tested?

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Performance enhancement (non-breaking change which improves efficiency)
Code cleanup (non-breaking change which makes code smaller or more readable)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation (a change to man pages or other documentation)

Checklist:

My code follows the ZFS on Linux code style requirements.
I have updated the documentation accordingly.
I have read the contributing document.
I have added tests to cover my changes.
All new and existing tests passed.
All commit messages are properly formatted and contain Signed-off-by.
Change has been approved by a ZFS on Linux member.

gmelikov · 2018-10-16T11:12:12Z

.github/ISSUE_TEMPLATE.md

@@ -11,6 +11,8 @@ questions on the mailing list.
 https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists

 Please fill in as much of the template as possible.
+
+Deleting this template may result in your issue being closed prematurely.


Let's move it at the beginning too.

ahrens · 2018-10-16T16:47:52Z

.github/ISSUE_TEMPLATE.md

@@ -1,3 +1,5 @@
+<!-- Deleting this template may result in your issue being closed prematurely. -->


I'd like to propose using positive language here.

Suggested change

I'm okay with this, but it doesn't address the issue of people deleting the template entirely. Would prefacing it with "please do not delete this template" be okay with you?

@bunder2015 I think it does address the issue of people deleting the template, because deleting the template is not filling it out.

@kpande By "positive" I mean let's tell folks what we want them to do, rather than what we don't want them to do.

I like @ahrens's wording here. There's value in explaining upfront why a template is provided and that filling it out will help their PR make it though the process.

I not understand why https://github.com/openzfs/openzfs/ have no "Issues" page, maybe to block tickets spam too?

@stephenmclan Since https://github.com/openzfs/openzfs/ repo is essentially a mirror of illumos, it uses the illumos bug tracking system: https://www.illumos.org/projects/illumos-gate/issues/

ahrens · 2018-10-16T16:48:24Z

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,5 @@
+<!--- Deleting this template may result in your Pull Request being closed prematurely. -->


Suggested change

behlendorf · 2018-10-16T17:55:44Z

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,5 @@
+<!--- Please fill out the following template, which will help other contributors review your Pull Request. -->
+


While your here, I'd suggest we drop the "Change has been approved by a ZFS on Linux member" line at the end. We've been using the issue labels for status tracking.

Occasionally we get issues and PRs from users who delete the templates. Advise users that their issues and PRs may be closed if they do not fill out the templates as we really need this information. Also updating PR template to drop unneeded approval toggle as we are now using issue labels for status tracking. Signed-off-by: bunder2015 <[email protected]>

behlendorf · 2018-10-17T05:42:06Z

@kpande I don't think that's a problem. We're free to handle the PR as appropriate, that may of course include closing it. The goal is to clearly state why it's in their best interests to fill out the template.

gmelikov · 2018-10-17T08:29:04Z

Unfortunately if somebody just deletes the template, it usually won't be even read. No matter what we will have such issues. :-( Let's merge it as is.

codecov · 2018-10-18T02:36:08Z

Codecov Report

Merging #8029 into master will decrease coverage by 0.26%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #8029      +/-   ##
==========================================
- Coverage   78.62%   78.35%   -0.27%     
==========================================
  Files         377      377              
  Lines      114333   114333              
==========================================
- Hits        89891    89588     -303     
- Misses      24442    24745     +303

Flag	Coverage Δ
#kernel	`78.7% <ø> (-0.24%)`	⬇️
#user	`67.43% <ø> (-0.36%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b2030e5...49228d3. Read the comment docs.

Occasionally we get issues and PRs from users who delete the templates. Advise users that their issues and PRs may be closed if they do not fill out the templates as we really need this information. Also updating PR template to drop unneeded approval toggle as we are now using issue labels for status tracking. Reviewed-by: Brian Behlendorf <[email protected]> Reviewed-by: George Melikov <[email protected]> Reviewed-by: Matthew Ahrens <[email protected]> Signed-off-by: bunder2015 <[email protected]> Closes openzfs#8029

gmelikov reviewed Oct 16, 2018

View reviewed changes

ahrens added the Status: Code Review Needed Ready for review and testing label Oct 16, 2018

ahrens requested changes Oct 16, 2018

View reviewed changes

behlendorf reviewed Oct 16, 2018

View reviewed changes

ahrens approved these changes Oct 16, 2018

View reviewed changes

behlendorf approved these changes Oct 16, 2018

View reviewed changes

gmelikov approved these changes Oct 17, 2018

View reviewed changes

ahrens added Status: Accepted Ready to integrate (reviewed, tested) and removed Status: Code Review Needed Ready for review and testing labels Oct 17, 2018

behlendorf merged commit bfcb82c into openzfs:master Oct 17, 2018

bunder2015 deleted the templates branch October 17, 2018 17:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Advise users to retain issue/PR templates #8029

Advise users to retain issue/PR templates #8029

bunder2015 commented Oct 16, 2018 •

edited

Loading

gmelikov Oct 16, 2018

ahrens Oct 16, 2018

bunder2015 Oct 16, 2018

ahrens Oct 16, 2018

behlendorf Oct 16, 2018

stephenmclan Oct 16, 2018

ahrens Oct 16, 2018

ahrens Oct 16, 2018

behlendorf Oct 16, 2018

bunder2015 Oct 16, 2018

behlendorf commented Oct 17, 2018

gmelikov commented Oct 17, 2018

codecov bot commented Oct 18, 2018

		@@ -1,3 +1,5 @@
		<!-- Deleting this template may result in your issue being closed prematurely. -->

	<!-- Deleting this template may result in your issue being closed prematurely. -->
	<!-- Please fill out the following template, which will help other contributors address your issue. -->

		@@ -1,3 +1,5 @@
		<!--- Deleting this template may result in your Pull Request being closed prematurely. -->

	<!--- Deleting this template may result in your Pull Request being closed prematurely. -->
	<!--- Please fill out the following template, which will help other contributors review your Pull Request. -->

Advise users to retain issue/PR templates #8029

Advise users to retain issue/PR templates #8029

Conversation

bunder2015 commented Oct 16, 2018 • edited Loading

Motivation and Context

Description

How Has This Been Tested?

Types of changes

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

behlendorf commented Oct 17, 2018

gmelikov commented Oct 17, 2018

codecov bot commented Oct 18, 2018

Codecov Report

bunder2015 commented Oct 16, 2018 •

edited

Loading