Skip to content

Commit

Permalink
Merge branch 'main' of github.com:PyCQA/pylint into pyreverse_type_hi…
Browse files Browse the repository at this point in the history
…nts_and_has_relationships
  • Loading branch information
mbyrnepr2 committed Jul 30, 2021
2 parents 70b36d4 + 5e5f48d commit 468a312
Show file tree
Hide file tree
Showing 102 changed files with 1,580 additions and 415 deletions.
63 changes: 0 additions & 63 deletions .github/ISSUE_TEMPLATE/1_Bug_report.md

This file was deleted.

23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/2_Feature_request.md

This file was deleted.

8 changes: 0 additions & 8 deletions .github/ISSUE_TEMPLATE/3_Question.md

This file was deleted.

105 changes: 105 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
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
placeholder: |
# Please disable message unrelated to the bug
# pylint: disable=missing-docstring,
<a> = b + 1
render: python
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)
placeholder: |
# Leave this blank if the configuration is not relevant!
[MASTER]
load-plugins=
pylint.extensions.code_style
[MESSAGE CONTROL]
enable=
useless-supression
# ...
render: ini
- type: textarea
id: cmd-used
attributes:
label: Command used
description: What was the command used to invoke pylint?
placeholder: |
pylint a.py
render: shell
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: Pylint output
description: What is the current pylint output?
placeholder: |
************* Module a
a.py:3:1: E0001: invalid syntax (<unknown>, line 1) (syntax-error)
render: shell
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: true
- type: textarea
id: python-interpreter
attributes:
label: Pylint version
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
validations:
required: true
- 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: |
pandas==0.23.2
marshmallow==3.10.0
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -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.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
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.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 💬 Discord
url: https://discord.gg/Egy6P8AMB5
about: Astroid and pylint informal dev discussion
16 changes: 4 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
-->
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ repos:
- --remove-duplicate-keys
- --remove-unused-variables
- repo: https://github.com/asottile/pyupgrade
rev: v2.21.2
rev: v2.23.0
hooks:
- id: pyupgrade
args: [--py36-plus]
Expand Down
6 changes: 6 additions & 0 deletions CONTRIBUTORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -518,6 +518,12 @@ contributors:
* Marco Gorelli: contributor
- Documented Jupyter integration

* Rebecca Turner (9999years): contributor

* Yilei Yang: contributor

* Marcin Kurczewski (rr-): contributor

* Eisuke Kawashima (e-kwsm): contributor

* Daniel van Noord (DanielNoord): contributor

0 comments on commit 468a312

Please sign in to comment.