[MRG] MNT create issue templates with automatic tagging #16053

glemaitre · 2020-01-08T13:25:25Z

Add a couple of issue template which can help for automatically labelling some issues and sometimes redirect users.

glemaitre · 2020-01-08T13:49:56Z

ping @cmarmo @thomasjpfan @adrinjalali @rth @qinhanmin2014 @jnothman @ogrisel

Any comments?

cmarmo · 2020-01-08T14:45:21Z

.github/ISSUE_TEMPLATE/usage_question.md

+- **StackOverflow with the scikit-learn tag: https://stackoverflow.com/questions/tagged/scikit-learn**
+- **Gitter: https://gitter.im/scikit-learn/scikit-learn**
+- **Mailing List: https://mail.python.org/mailman/listinfo/scikit-learn**


Just a comment / question : the order means a priority? Which of those channels is the most reliable for the core-devs? That one should go first, probably...

I did not put any order indeed.

Even if I am sometimes disappointed with some SO answers, this might be the channel the most reliable to get an answer fast (maybe the wrong one :)).

I put it in the order that I would think the best but this is opened to discucssion :)

I think we should favor SO first because of google-ability and reuse of past answers.

thomasjpfan · 2020-01-08T16:23:01Z

I uploaded these template to a test repo to see what it looks like.

Do we need the titles to be tagged with [DOC], [ENH], etc?

glemaitre · 2020-01-08T16:25:49Z

Not necessary since we have the tags. Happy

…

On Wed, 8 Jan 2020 at 17:23, Thomas J Fan ***@***.***> wrote: I updated these template to a test repo <https://github.com/thomasjpfan/test_issue_templates/issues/new/choose> to see what it looks like. Do we need the titles to be tagged with [DOC], [ENH], etc? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#16053?email_source=notifications&email_token=ABY32P545YZD3FZBVIOXLXDQ4X4WRA5CNFSM4KEIJ2F2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEINECHI#issuecomment-572145949>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABY32P6FQTMCXJKBF3XDEMTQ4X4WRANCNFSM4KEIJ2FQ> .

-- Guillaume Lemaitre Scikit-learn @ Inria Foundation https://glemaitre.github.io/

.github/ISSUE_TEMPLATE/blank_template.md

.github/ISSUE_TEMPLATE/bug_report.md

.github/ISSUE_TEMPLATE/doc_improvement.md

.github/ISSUE_TEMPLATE/feature_request.md

.github/ISSUE_TEMPLATE/usage_question.md

.github/ISSUE_TEMPLATE/feature_request.md

.github/ISSUE_TEMPLATE/doc_improvement.md

adrinjalali

Nice :)

.github/ISSUE_TEMPLATE/bug_report.md

.github/ISSUE_TEMPLATE/doc_improvement.md

.github/ISSUE_TEMPLATE/feature_request.md

.github/ISSUE_TEMPLATE/usage_question.md

Co-Authored-By: Adrin Jalali <[email protected]> Co-Authored-By: Thomas J Fan <[email protected]>

jnothman

Otherwise lgtm

.github/ISSUE_TEMPLATE/doc_improvement.md

jnothman · 2020-01-09T20:52:34Z

.github/ISSUE_TEMPLATE/blank_template.md

@@ -0,0 +1,10 @@
+---
+name: Other (blank template)


Not sure we need this?

Do you mean the template as a whole or the "(blank template)" sentence?

This probably fits a bunch of issues maintainers create. We could try and fit our own issues in the other categories, but I guess having this wouldn't hurt. No strong opinion though.

Do we want to add an RFC (whatever RFC means)?

C -> changes or comments :)

Co-Authored-By: Joel Nothman <[email protected]>

NicolasHug

This looks great

Shouldn't the text in the templates be written as comments? Else it will show up often since users won't delete it, and create noise

We could also add a quick sentence asking users to look for previous issues / PRs

.github/ISSUE_TEMPLATE/feature_request.md

.github/ISSUE_TEMPLATE/usage_question.md

.github/ISSUE_TEMPLATE/feature_request.md

.github/ISSUE_TEMPLATE/bug_report.md

Co-Authored-By: Nicolas Hug <[email protected]>

glemaitre · 2020-01-13T11:39:56Z

I address @NicolasHug adding comment tag to avoid noise. I added a template for the RFC.
Are we fine to merge this first version?

NicolasHug

happy to merge but I'd remove the RFC template since it's empty and there is already the blank template

.github/ISSUE_TEMPLATE/bug_report.md

glemaitre · 2020-01-13T12:34:07Z

OK done now.

.github/ISSUE_TEMPLATE/feature_request.md

.github/ISSUE_TEMPLATE/bug_report.md

ogrisel · 2020-01-13T17:13:21Z

.github/ISSUE_TEMPLATE/bug_report.md

+    evaluate_every=10,
+    n_jobs=4,
+)
+model = lda_model.fit(lda_features)


This example could be simplified to use np.ranom.RandomState(42).normal(size=(n_samples, n_features)) and a more common estimator such as RandomForestClassifier instead. But let's do that in a later PR.

ogrisel · 2020-01-13T17:14:40Z

.github/ISSUE_TEMPLATE/usage_question.md

+- **StackOverflow with the scikit-learn tag: https://stackoverflow.com/questions/tagged/scikit-learn**
+- **Gitter: https://gitter.im/scikit-learn/scikit-learn**
+- **Mailing List: https://mail.python.org/mailman/listinfo/scikit-learn**


I think we should favor SO first because of google-ability and reuse of past answers.

ogrisel

I would also remove the RFC template. I think core-devs would naturally use the blank template when they want to open an RFC.

Co-Authored-By: Olivier Grisel <[email protected]>

glemaitre · 2020-01-13T17:19:39Z

OK I applied the changes and remove the RFC, let's go live to see how it looks like

amueller · 2020-01-13T17:41:50Z

this is awesome!

jnothman · 2020-01-13T22:58:02Z

Yay, thanks for making this happen Guillaume!

MNT create issue templates with automatic tagging

397cf10

cmarmo reviewed Jan 8, 2020

View reviewed changes

thomasjpfan reviewed Jan 8, 2020

View reviewed changes

address comments

3b59e0d

thomasjpfan reviewed Jan 8, 2020

View reviewed changes

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

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

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

adrinjalali reviewed Jan 8, 2020

View reviewed changes

glemaitre and others added 3 commits January 8, 2020 18:37

Apply suggestions from code review

1974cbd

Co-Authored-By: Adrin Jalali <[email protected]> Co-Authored-By: Thomas J Fan <[email protected]>

remove first good issue

523a0e6

add explanation regardng reproducibility

da9afd5

glemaitre changed the title ~~MNT create issue templates with automatic tagging~~ [MRG] MNT create issue templates with automatic tagging Jan 9, 2020

address Adrin comments

c5dc7bb

thomasjpfan approved these changes Jan 9, 2020

View reviewed changes

jnothman approved these changes Jan 9, 2020

View reviewed changes

Update .github/ISSUE_TEMPLATE/doc_improvement.md

7e77c2e

Co-Authored-By: Joel Nothman <[email protected]>

adrinjalali approved these changes Jan 10, 2020

View reviewed changes

NicolasHug reviewed Jan 11, 2020

View reviewed changes

glemaitre and others added 4 commits January 13, 2020 12:29

Apply suggestions from code review

47dde6f

Co-Authored-By: Nicolas Hug <[email protected]>

add comment tags

4ad5571

Update labels

8291cb6

update tags

2d8174a

NicolasHug approved these changes Jan 13, 2020

View reviewed changes

.github/ISSUE_TEMPLATE/bug_report.md Show resolved Hide resolved

address nicolas comments

dec55da

ogrisel reviewed Jan 13, 2020

View reviewed changes

ogrisel approved these changes Jan 13, 2020

View reviewed changes

Apply suggestions from code review

e2168cc

Co-Authored-By: Olivier Grisel <[email protected]>

remove rfc

b138bdf

glemaitre merged commit 8e61534 into scikit-learn:master Jan 13, 2020

thomasjpfan pushed a commit to thomasjpfan/scikit-learn that referenced this pull request Feb 22, 2020

MNT create issue templates with automatic tagging (scikit-learn#16053)

d6175db

panpiort8 pushed a commit to panpiort8/scikit-learn that referenced this pull request Mar 3, 2020

MNT create issue templates with automatic tagging (scikit-learn#16053)

cdf5b2c

Uh oh!

[MRG] MNT create issue templates with automatic tagging #16053

[MRG] MNT create issue templates with automatic tagging #16053

Uh oh!

Conversation

glemaitre commented Jan 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

glemaitre commented Jan 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thomasjpfan commented Jan 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

glemaitre commented Jan 8, 2020 via email

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adrinjalali left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jnothman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NicolasHug left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

glemaitre commented Jan 13, 2020

Uh oh!

NicolasHug left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

glemaitre commented Jan 13, 2020

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ogrisel left a comment

Choose a reason for hiding this comment

Uh oh!

glemaitre commented Jan 8, 2020 •

edited

Loading

glemaitre commented Jan 8, 2020 •

edited

Loading

thomasjpfan commented Jan 8, 2020 •

edited

Loading