summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2021-07-25 19:53:19 +0200
committerGitHub <noreply@github.com>2021-07-25 19:53:19 +0200
commitf17b28e427250cf2e52aa5ae947ba5521d398102 (patch)
tree1708e52e83a4217ee672cdd50312714390f6ad27 /.github
parenta054796d7008f4531b482490f917bdef1454b8fd (diff)
downloadpylint-git-f17b28e427250cf2e52aa5ae947ba5521d398102.tar.gz
Add Github issue forms and densify some templates (#4742)
* 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
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/1_Bug_report.md63
-rw-r--r--.github/ISSUE_TEMPLATE/2_Feature_request.md23
-rw-r--r--.github/ISSUE_TEMPLATE/3_Question.md8
-rw-r--r--.github/ISSUE_TEMPLATE/BUG-REPORT.yml96
-rw-r--r--.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml45
-rw-r--r--.github/ISSUE_TEMPLATE/QUESTION.yml49
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml5
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md16
8 files changed, 199 insertions, 106 deletions
diff --git a/.github/ISSUE_TEMPLATE/1_Bug_report.md b/.github/ISSUE_TEMPLATE/1_Bug_report.md
deleted file mode 100644
index 88a20e0c0..000000000
--- a/.github/ISSUE_TEMPLATE/1_Bug_report.md
+++ /dev/null
@@ -1,63 +0,0 @@
----
-name: Bug report
-about: Report a bug in pylint
----
-
-<!--
- Hi there! Thank you for discovering and submitting an issue.
-
- Before you submit this, make sure that the issue doesn't already exist
- or if it is not closed.
-
- Is your issue fixed on the preview release?:
- pip install pylint astroid --pre -U
--->
-
-### Steps to reproduce
-
-<!--
-Given a file `a.py`:
-```python
-# (Disable message unrelated to the bug)
-# pylint: disable=missing-docstring,...
-
-```
-
-Given multiple files:
-```
-__init__.py
-a.py
-module\
- __init__.py
- b.py
- c.py
-```
--->
-
-### Current behavior
-
-<!--
-Result of `pylint a.py`:
-```
-
-```
--->
-
-### Expected behavior
-
-### pylint --version output
-
-Result of `pylint --version` output:
-
-```
-
-```
-
-<!--
-Additional dependencies:
-```
-pandas==0.23.2
-marshmallow==3.10.0
-...
-```
--->
diff --git a/.github/ISSUE_TEMPLATE/2_Feature_request.md b/.github/ISSUE_TEMPLATE/2_Feature_request.md
deleted file mode 100644
index 0676e4636..000000000
--- a/.github/ISSUE_TEMPLATE/2_Feature_request.md
+++ /dev/null
@@ -1,23 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
----
-
-<!--
- Hi there! Thank you for wanting to make pylint better.
-
- Before you submit this, make sure that this feature wasn't
- already requested or if it is not already implemented in the main branch.
--->
-
-### Is your feature request related to a problem? Please describe
-
-A clear and concise description of what the problem is.
-
-### Describe the solution you'd like
-
-A clear and concise description of what you want to happen.
-
-### Additional context
-
-Add any other context about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/3_Question.md b/.github/ISSUE_TEMPLATE/3_Question.md
deleted file mode 100644
index 7e9187d85..000000000
--- a/.github/ISSUE_TEMPLATE/3_Question.md
+++ /dev/null
@@ -1,8 +0,0 @@
----
-name: Support question
-about:
- Questions about pylint that are not covered in the documentation
- (https://pylint.pycqa.org/en/latest/)
----
-
-## Question
diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
new file mode 100644
index 000000000..5118cd5b8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
@@ -0,0 +1,96 @@
+name: 🐛 Bug report
+description: Report a bug in pylint
+labels: [bug, needs triage]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ **Thank you for wanting to report a bug in pylint!**
+
+ ⚠ Please make sure that this [issue wasn't already requested][issue search], or already implemented in the main branch.
+
+
+ [issue search]: https://github.com/PyCQA/pylint/issues?q=is%3Aissue+is%3Aopen+
+
+ - type: textarea
+ id: what-happened
+ attributes:
+ label: Bug description
+ description:
+ What is the bug about? Please provide the code that is causing the issue, and
+ configurations used if required
+ value: |
+ Given a file `a.py`:
+
+ ```python
+ # Please disable message unrelated to the bug
+ # pylint: disable=missing-docstring,
+ <a> = b + 1
+ ```
+ validations:
+ required: true
+ - type: textarea
+ id: configuration
+ attributes:
+ label: (Configuration)
+ description:
+ Please provide the part of the configuration that is causing the bug if required
+ (Leave this part blank if the configuration is not relevant)
+ value: |
+ Using the following configuration:
+ ```ini
+ ```
+ validations:
+ required: false
+ - type: textarea
+ id: current-behavior
+ attributes:
+ label: Command used
+ description: What is the command used and its actual output ?
+ value: |
+ Result of `pylint a.py`:
+ ```
+ ************* Module a
+ a.py:3:1: E0001: invalid syntax (<unknown>, line 1) (syntax-error)
+ ```
+ validations:
+ required: true
+ - type: textarea
+ id: future-behavior
+ attributes:
+ label: (Expected behavior)
+ description:
+ What would you expect instead ? For example expected output or behavior
+ validations:
+ required: false
+ - type: textarea
+ id: python-interpreter
+ attributes:
+ label: (Version affected)
+ description:
+ Please copy and paste the result of 'pylint --version' or specify the range of
+ version affected
+ placeholder: |
+ pylint 2.9.6
+ astroid 2.6.5
+ Python 3.8.10 (default, Jun 2 2021, 10:49:15)
+ [GCC 9.4.0]
+ render: shell
+ - type: textarea
+ attributes:
+ label: (OS / Environment)
+ description: >-
+ Provide all relevant information below, e.g. OS version, terminal etc.
+ placeholder: Fedora 33, Cygwin, etc.
+ - type: textarea
+ id: additional-deps
+ attributes:
+ label: (Additional dependencies)
+ description: If applicable ie, if we can't reproduce without it
+ placeholder: |
+ Additional dependencies:
+ ```
+ pandas==0.23.2
+ marshmallow==3.10.0
+ ...
+ ```
diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
new file mode 100644
index 000000000..59257ba0d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
@@ -0,0 +1,45 @@
+name: ✨ Feature request
+description: Suggest an idea for pylint
+labels: [enhancement, needs triage]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ **Thank you for wanting to make a suggestion for pylint!**
+
+ ⚠ Please make sure that [this feature wasn't already requested][issue search] or already implemented in the main branch.
+
+
+ [issue search]: https://github.com/PyCQA/pylint/issues?q=is%3Aissue+is%3Aopen+
+
+ - type: textarea
+ id: current-problem
+ attributes:
+ label: Current problem
+ description:
+ What are you trying to do, that you are unable to achieve with pylint as it
+ currently stands?
+ placeholder: >-
+ I'm trying to do X and I'm missing feature Y for this to be easily achievable.
+ validations:
+ required: true
+ - type: textarea
+ id: proposed-solution
+ attributes:
+ label: Desired solution
+ description: A clear and concise description of what you want to happen.
+ placeholder: >-
+ When I do X, I want to achieve Y in a situation when Z.
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: (Additional context)
+ description: >
+ Add any other context, links, etc. about the feature here. Describe how the
+ feature would be used, why it is needed and what it would solve.
+
+ **HINT:** You can paste https://gist.github.com links for larger files.
+ placeholder: >-
+ I asked on https://stackoverflow.com/... and the community advised me to do X, Y
+ and Z.
diff --git a/.github/ISSUE_TEMPLATE/QUESTION.yml b/.github/ISSUE_TEMPLATE/QUESTION.yml
new file mode 100644
index 000000000..b01f52603
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/QUESTION.yml
@@ -0,0 +1,49 @@
+name: 🤔 Support question
+description: Questions about pylint that are not covered in the documentation
+labels: [question, needs triage, documentation]
+body:
+ - type: markdown
+ attributes:
+ value: >
+ **Thank you for wanting to report a problem with pylint documentation!**
+
+
+ Please fill out your suggestions below. If the problem seems straightforward,
+ feel free to go ahead and submit a pull request instead!
+
+
+ ⚠ Verify first that your issue is not [already reported on GitHub][issue
+ search].
+
+ 💬 If you are seeking community support, please consider [starting a discussion
+ on Discord][Discussions].
+
+
+ [issue search]: https://github.com/PyCQA/pylint/issues?q=is%3Aissue+is%3Aopen+
+
+ [Discussions]: https://discord.gg/Egy6P8AMB5
+
+ - type: textarea
+ id: question
+ attributes:
+ label: Question
+ validations:
+ required: true
+ - type: textarea
+ id: documentation
+ attributes:
+ label: Documentation for future user
+ description:
+ Where did you expect this information to be ? What do we need to add or what do
+ we need to reorganize ?
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: (Additional context)
+ description: >
+ Add any other context, links, etc. about the question here.
+
+ placeholder: >-
+ I asked on https://stackoverflow.com/... and the community advised me to do X, Y
+ and Z.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..4e8b5ce05
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+ - name: 💬 Discord
+ url: https://discord.gg/Egy6P8AMB5
+ about: Astroid and pylint informal dev discussion
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index b272731b2..5cb6329f6 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,22 +1,14 @@
<!--
-
Thank you for submitting a PR to pylint!
To ease the process of reviewing your PR, do make sure to complete the following boxes.
-You can also read more about contributing to pylint in this document:
-https://github.com/PyCQA/pylint/blob/main/doc/development_guide/contribute.rst#repository
--->
-
-## Steps
-
- [ ] Add yourself to CONTRIBUTORS if you are a new contributor.
- [ ] Add a ChangeLog entry describing what your PR does.
-- [ ] If it's a new feature or an important bug fix, add a What's New entry in
+- [ ] If it's a new feature, or an important bug fix, add a What's New entry in
`doc/whatsnew/<current release.rst>`.
- [ ] Write a good description on what the PR does.
-
-## Description
+-->
## Type of Changes
@@ -29,11 +21,11 @@ https://github.com/PyCQA/pylint/blob/main/doc/development_guide/contribute.rst#r
| ✓ | :hammer: Refactoring |
| ✓ | :scroll: Docs |
-## Related Issue
+## Description
<!--
If this PR fixes a particular issue, use the following to automatically close that issue
once this PR gets merged:
+-->
Closes #XXX
--->