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.

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

Add Github issue forms #4735

Closed
cdce8p opened this issue Jul 21, 2021 · 4 comments · Fixed by #4742
Closed

Add Github issue forms #4735

cdce8p opened this issue Jul 21, 2021 · 4 comments · Fixed by #4742
Assignees
Labels
Maintenance Discussion or action around maintaining pylint or the dev workflow
Milestone

Comments

@cdce8p
Copy link
Member

cdce8p commented Jul 21, 2021

Is your feature request related to a problem? Please describe

The current issue template for bug reports can sometimes be quite confusing. Especially since it's not always clear where a comment starts/ends and what someone needs to fill out.

Describe the solution you'd like

Start using Github issue forms to make filing a bug report easier.

Additional context

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms

@Pierre-Sassoulas Pierre-Sassoulas added Maintenance Discussion or action around maintaining pylint or the dev workflow task labels Jul 21, 2021
@Pierre-Sassoulas
Copy link
Member

It looks amazing, thank you for bringing that up.

@Pierre-Sassoulas
Copy link
Member

Made a first try here : https://github.com/Pierre-Sassoulas/pylint/issues/new/choose

I think it looks very nice. the only problem is linked to yaml where you can't import so we'll have to duplicate.

I was thinking about making "Crash", "Bug", "False Positive", "False Negative", "Feature request" and "Question", what do you think ?

@cdce8p
Copy link
Member Author

cdce8p commented Jul 21, 2021

Not sure we should really differentiate too much. It doesn't help if we have a nice form but a beginner doesn't know which to choose. We triage them afterwards anyway. Therefore I would suggest to stick to just Bug, Feature request, and Question.

One more thing, with the current template we assume that the issue is caused by multiple files: Given file a and given file b. At least from what I've seen so far, most are actually just caused by a single one. Maybe we should remove file b.

@Pierre-Sassoulas
Copy link
Member

That would permit to apply label automatically and have a template that is more relevant. But I think you're right, there's already a lot with all the link added and not a lot changing from false positive/negative and bug.

@Pierre-Sassoulas Pierre-Sassoulas added this to the 2.10.0 milestone Jul 22, 2021
@Pierre-Sassoulas Pierre-Sassoulas self-assigned this Jul 22, 2021
Pierre-Sassoulas added a commit to Pierre-Sassoulas/pylint that referenced this issue Jul 25, 2021
Pierre-Sassoulas added a commit to Pierre-Sassoulas/pylint that referenced this issue Jul 25, 2021
Pierre-Sassoulas added a commit that referenced this issue Jul 25, 2021
* Add links in .github/ISSUE_TEMPLATE/config.yml
* Start using github's form in issue template

Closes #4735

* More condensed pull request template
* Cleanup of .github/ISSUE_TEMPLATE/config.yml it's supposed to be contact links
* Add more emojies take setuptools example
* Make the configuration optional in the bug report template
* Add optional additional context in question/support
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance Discussion or action around maintaining pylint or the dev workflow
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants