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 and densify some templates #4742

Merged
merged 7 commits into from Jul 25, 2021

Conversation

Pierre-Sassoulas
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas commented Jul 25, 2021

Type of Changes

Type
βœ“ πŸ”¨ Refactoring
βœ“ πŸ“œ Docs

Description

This start using the form template that are still in beta. Result can be seen and tested here: https://github.com/Pierre-Sassoulas/pylint/issues/new/choose

Closes #4735

@Pierre-Sassoulas Pierre-Sassoulas added Enhancement ✨ Improvement to a component Documentation πŸ“— Maintenance Discussion or action around maintaining pylint or the dev workflow labels Jul 25, 2021
@Pierre-Sassoulas Pierre-Sassoulas added this to the 2.9.6 milestone Jul 25, 2021
@coveralls
Copy link

coveralls commented Jul 25, 2021

Coverage Status

Coverage remained the same at 92.154% when pulling 5f6485d on Pierre-Sassoulas:main into a054796 on PyCQA:main.

Copy link
Member

@cdce8p cdce8p left a comment

Choose a reason for hiding this comment

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

Left some comments.

If you like, take a look at the BUG template for setuptools: https://github.com/pypa/setuptools/issues/new?assignees=&labels=bug%2CNeeds+Triage&template=bug-report.yml&title=%5BBUG%5D+

.github/ISSUE_TEMPLATE/BUG-REPORT.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/BUG-REPORT.yml Outdated Show resolved Hide resolved
Comment on lines +17 to +18
Given a file `a.py`:

Copy link
Member

Choose a reason for hiding this comment

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

These lines are not really necessary

Copy link
Member Author

Choose a reason for hiding this comment

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

Well I think it nudges the reporter to provide a reproducible example and I really like having a reproducible example, I think I'll keep that.

.github/ISSUE_TEMPLATE/BUG-REPORT.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/BUG-REPORT.yml Outdated Show resolved Hide resolved
label: What is the command used and its actual output ?
description: Please provide the command used and the current output
value: |
Result of `pylint a.py`:
Copy link
Member

Choose a reason for hiding this comment

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

This line is also not really necessary

Copy link
Member Author

Choose a reason for hiding this comment

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

Very often the reporter do not gives the pylint output and just gives a general description "I don't like the output", I'll also keep this, that as it nudges reporter to make a report that permits to understand the problem without thinking too much or linting the code ourselves.

.github/ISSUE_TEMPLATE/BUG-REPORT.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml Outdated Show resolved Hide resolved
@Pierre-Sassoulas
Copy link
Member Author

Pierre-Sassoulas commented Jul 25, 2021

Thank you for the review and the original idea @cdce8p, I think these new forms are great !

@Pierre-Sassoulas Pierre-Sassoulas merged commit f17b28e into pylint-dev:main Jul 25, 2021
@cdce8p cdce8p mentioned this pull request Jul 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation πŸ“— Enhancement ✨ Improvement to a component Maintenance Discussion or action around maintaining pylint or the dev workflow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Github issue forms
3 participants