Issue policy and template tweaks #2739

dbczumar · 2020-04-22T00:08:03Z

What changes are proposed in this pull request?

Revamp "feature request" template to prompt filers for specific motivation questions and high-level implementation details (if possible)
Revamp Issue Policy to address the lifecycle for each issue type
Add "Willingness to contribute" sections to the feature request, bug report, and documentation fix templates

How is this patch tested?

Manually - I recommend viewing the associated files in a markdown renderer (e.g., open the file in the GitHub file browser).

Release Notes

Is this a user-facing change?

No. You can skip the rest of this section.
Yes. Give a description of this change to be included in the release notes for MLflow users.

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)

What component(s) does this PR affect?

How should the PR be classified in the release notes? Choose one:

rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
rn/feature - A new user-facing feature worth mentioning in the release notes
rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
rn/documentation - A user-facing documentation change worth mentioning in the release notes

dbczumar · 2020-04-22T19:35:01Z

.github/ISSUE_TEMPLATE/feature_request_template.md

+- [ ] Scoring
+- [ ] Serving


@sueann Can we dedupe Scoring and Serving here and in the pull request template?

Maybe also API and REST-API? Dunno how a user would choose between those.

sounds good - i think we want to just keep "Scoring"

Thanks for the input! I've consolidated Serving and Scoring to just Scoring. I've consolidated API and REST-API as just API.

aarondav · 2020-04-22T20:55:00Z

.github/ISSUE_TEMPLATE/bug_report_template.md


-Please fill in this template and do not delete it unless you are sure your issue is outside its scope.
+**Please fill in this bug report template to ensure a thorough response.**


Do I want a thorough response? Quick? Some other word?

I've changed this to timely and thorough. More than happy to iterate here though!

^ I applied these changes to the PR template as well

aarondav · 2020-04-22T20:56:00Z

.github/ISSUE_TEMPLATE/bug_report_template.md

+
+- [ ] Yes. I can contribute a fix for this bug independently.
+- [ ] Yes. I would be willing to contribute a fix for this bug with guidance from the MLflow community.
+- [ ] No. **Explanation:**


Probably we can leave out the Explanation bit. Just having "No" here is already 🤨

aarondav · 2020-04-22T20:57:05Z

.github/ISSUE_TEMPLATE/feature_request_template.md

+
+- [ ] Yes. I think this feature can be introduced as an MLflow Plugin.
+- [ ] No. It does not make sense to structure this feature as an MLflow Plugin. **Explanation:**
+- [ ] No. I don’t think MLflow Plugins currently supports this type of feature. **Explanation:**


s/supports/support/?

Done! Thanks!

codecov-io · 2020-04-22T22:53:43Z

Codecov Report

Merging #2739 into master will increase coverage by 0.19%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2739      +/-   ##
==========================================
+ Coverage   85.04%   85.23%   +0.19%     
==========================================
  Files          20       20              
  Lines        1050     1050              
==========================================
+ Hits          893      895       +2     
+ Misses        157      155       -2

Impacted Files	Coverage Δ
R/tracking-server.R	`100.00% <0.00%> (+3.77%)`	⬆️

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 2300d8e...de253ea. Read the comment docs.

dbczumar · 2020-04-23T08:55:56Z

@aarondav @smurching @mateiz In response to feedback that the feature request template is too lengthy and technical, I've removed the sections related to plugins and implementation impact from the template. Instead, I've updated the CONTRIBUTING.rst document to provide guidelines about feature / patch design and information about structuring features as plugins, as well as an overview of the contribution process. The feature request template explicitly encourages users to consult the contributing guide. Another round of reviews would be greatly appreciated!

dbczumar · 2020-04-23T08:58:29Z

CONTRIBUTING.rst

+MLflow committers actively triage and respond to GitHub issues. In general, we recommend waiting
+for feebdack from an MLflow committer or community member before proceeding to implement a feature
+or patch. This is particularly important for
+`significant changes <https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst#write-designs-for-significant-changes>`_.


I tried using RST references (:ref:) to link to sections within this document. Unfortunately, GitHub doesn't seem to render RST references properly (see isaacs/github#892), so I gave this a shot instead.

mateiz · 2020-04-23T16:08:40Z

.github/ISSUE_TEMPLATE/feature_request_template.md

+## Which MLflow component(s) does this feature affect?
+
+- [ ] UI
+- [ ] CLI


Some people might not know what CLI stands for so maybe spell it out

Changed this to read Command Line Interface and also made the corresponding change to the pull request template. Thanks for pointing this out!

.github/ISSUE_TEMPLATE/feature_request_template.md

smurching

One nit, but otherwise LGTM thanks @dbczumar!

Co-Authored-By: Siddharth Murching <smurching@gmail.com>

* Initial * Tweaks * Spacing * Bug fix * Lang * Unbold * Doc issues * Tweak * Installation * Issue policy * Ordering * Update guidelines * Address feedback * Address * Spacing * Progress * Format * template update * Address comments * Whitespace fixes for contributing guide * Update .github/ISSUE_TEMPLATE/feature_request_template.md Co-Authored-By: Siddharth Murching <smurching@gmail.com> Co-authored-by: Siddharth Murching <smurching@gmail.com>

dbczumar added 11 commits April 21, 2020 16:27

Initial

6292313

Tweaks

5aa00bd

Spacing

c89b18f

Bug fix

a4965e8

Lang

8f682af

Unbold

314130b

Doc issues

987a116

Tweak

5ab60de

Installation

21be3fd

Issue policy

25dcdde

Ordering

d88a722

dbczumar requested review from smurching and Zangr April 22, 2020 00:08

Update guidelines

815b62f

dbczumar commented Apr 22, 2020

View reviewed changes

aarondav reviewed Apr 22, 2020

View reviewed changes

Address feedback

de253ea

aarondav approved these changes Apr 22, 2020

View reviewed changes

dbczumar added 5 commits April 23, 2020 00:38

Address

165cf21

Spacing

f053272

Progress

c1da70c

Format

cbe019a

template update

2485c16

dbczumar commented Apr 23, 2020

View reviewed changes

mateiz reviewed Apr 23, 2020

View reviewed changes

Address comments

de3c549

Whitespace fixes for contributing guide

88f248e

smurching reviewed Apr 23, 2020

View reviewed changes

.github/ISSUE_TEMPLATE/feature_request_template.md Outdated Show resolved Hide resolved

smurching approved these changes Apr 23, 2020

View reviewed changes

dbczumar changed the title ~~[WIP] Issue policy and template tweaks~~ Issue policy and template tweaks Apr 23, 2020

Update .github/ISSUE_TEMPLATE/feature_request_template.md

abe1be3

Co-Authored-By: Siddharth Murching <smurching@gmail.com>

dbczumar merged commit 8eb4da0 into mlflow:master Apr 24, 2020

smurching added the rn/none List under Small Changes in Changelogs. label Jun 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue policy and template tweaks #2739

Issue policy and template tweaks #2739

dbczumar commented Apr 22, 2020

dbczumar Apr 22, 2020

aarondav Apr 22, 2020

sueann Apr 22, 2020

dbczumar Apr 22, 2020

aarondav Apr 22, 2020 •

edited

Loading

dbczumar Apr 22, 2020

dbczumar Apr 22, 2020

aarondav Apr 22, 2020

dbczumar Apr 22, 2020

aarondav Apr 22, 2020

dbczumar Apr 22, 2020

codecov-io commented Apr 22, 2020

dbczumar commented Apr 23, 2020

dbczumar Apr 23, 2020

mateiz Apr 23, 2020

dbczumar Apr 23, 2020

smurching left a comment


		Please fill in this template and do not delete it unless you are sure your issue is outside its scope.
		Please fill in this bug report template to ensure a thorough response.

Issue policy and template tweaks #2739

Issue policy and template tweaks #2739

Conversation

dbczumar commented Apr 22, 2020

What changes are proposed in this pull request?

How is this patch tested?

Release Notes

Is this a user-facing change?

What component(s) does this PR affect?

How should the PR be classified in the release notes? Choose one:

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

aarondav Apr 22, 2020 • edited Loading

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

codecov-io commented Apr 22, 2020

Codecov Report

dbczumar commented Apr 23, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smurching left a comment

Choose a reason for hiding this comment

aarondav Apr 22, 2020 •

edited

Loading