summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2021-04-07 21:42:36 +0200
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2021-04-07 22:02:01 +0200
commitb6ce99bb8158c4ac05ae7f0bd6fd12c6cdbeaa11 (patch)
treeea9e0304d698e0d7f224283c27e27ef74f6fbbde /.github
parent3420964a2ed8fd553e07efb1096b14dddcd2332c (diff)
downloadpylint-git-b6ce99bb8158c4ac05ae7f0bd6fd12c6cdbeaa11.tar.gz
Add prettier to the pre-commit configuration
Also apply prettier
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md3
-rw-r--r--.github/ISSUE_TEMPLATE/1_Bug_report.md4
-rw-r--r--.github/ISSUE_TEMPLATE/2_Feature_request.md4
-rw-r--r--.github/ISSUE_TEMPLATE/3_Question.md5
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md18
-rw-r--r--.github/workflows/ci.yaml27
6 files changed, 36 insertions, 25 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index e3a9ff424..e3c97eb96 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1 +1,2 @@
-Please read the [contribute doc](https://github.com/PyCQA/pylint/blob/master/doc/development_guide/contribute.rst).
+Please read the
+[contribute doc](https://github.com/PyCQA/pylint/blob/master/doc/development_guide/contribute.rst).
diff --git a/.github/ISSUE_TEMPLATE/1_Bug_report.md b/.github/ISSUE_TEMPLATE/1_Bug_report.md
index b4c2e1ddc..88a20e0c0 100644
--- a/.github/ISSUE_TEMPLATE/1_Bug_report.md
+++ b/.github/ISSUE_TEMPLATE/1_Bug_report.md
@@ -1,7 +1,6 @@
---
name: Bug report
about: Report a bug in pylint
-
---
<!--
@@ -36,6 +35,7 @@ module\
-->
### Current behavior
+
<!--
Result of `pylint a.py`:
```
@@ -45,10 +45,10 @@ Result of `pylint a.py`:
### Expected behavior
-
### pylint --version output
Result of `pylint --version` output:
+
```
```
diff --git a/.github/ISSUE_TEMPLATE/2_Feature_request.md b/.github/ISSUE_TEMPLATE/2_Feature_request.md
index b9dca130d..1a0a39859 100644
--- a/.github/ISSUE_TEMPLATE/2_Feature_request.md
+++ b/.github/ISSUE_TEMPLATE/2_Feature_request.md
@@ -1,7 +1,6 @@
---
name: Feature request
about: Suggest an idea for this project
-
---
<!--
@@ -12,10 +11,13 @@ about: Suggest an idea for this project
-->
### 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
index 5787c384b..7e9187d85 100644
--- a/.github/ISSUE_TEMPLATE/3_Question.md
+++ b/.github/ISSUE_TEMPLATE/3_Question.md
@@ -1,7 +1,8 @@
---
name: Support question
-about: Questions about pylint that are not covered in the documentation (https://pylint.pycqa.org/en/latest/)
-
+about:
+ Questions about pylint that are not covered in the documentation
+ (https://pylint.pycqa.org/en/latest/)
---
## Question
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index d0eb306c7..05a2447d4 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -12,20 +12,22 @@ https://github.com/PyCQA/pylint/blob/master/doc/development_guide/contribute.rst
- [ ] 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 `doc/whatsnew/<current release.rst>`.
+- [ ] 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
+
<!-- Leave the corresponding lines for the applicable type of change: -->
-| | Type |
-| ------------- | ------------- |
-| ✓ | :bug: Bug fix |
-| ✓ | :sparkles: New feature |
-| ✓ | :hammer: Refactoring |
-| ✓ | :scroll: Docs |
+
+| | Type |
+| --- | ---------------------- |
+| ✓ | :bug: Bug fix |
+| ✓ | :sparkles: New feature |
+| ✓ | :hammer: Refactoring |
+| ✓ | :scroll: Docs |
## Related Issue
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index 082c3d094..fd4ec0c5f 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -12,7 +12,6 @@ env:
DEFAULT_PYTHON: 3.6
PRE_COMMIT_CACHE: ~/.cache/pre-commit
-
jobs:
prepare-base:
name: Prepare base dependencies
@@ -88,7 +87,8 @@ jobs:
uses: actions/cache@v2.1.4
with:
path: venv
- key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
+ key:
+ ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
needs.prepare-base.outputs.python-key }}
- name: Fail job if Python cache restore failed
if: steps.cache-venv.outputs.cache-hit != 'true'
@@ -129,7 +129,8 @@ jobs:
uses: actions/cache@v2.1.4
with:
path: venv
- key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
+ key:
+ ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
needs.prepare-base.outputs.python-key }}
- name: Fail job if Python cache restore failed
if: steps.cache-venv.outputs.cache-hit != 'true'
@@ -202,7 +203,8 @@ jobs:
uses: actions/cache@v2.1.4
with:
path: venv
- key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
+ key:
+ ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
needs.prepare-tests-linux.outputs.python-key }}
- name: Fail job if Python cache restore failed
if: steps.cache-venv.outputs.cache-hit != 'true'
@@ -241,7 +243,8 @@ jobs:
uses: actions/cache@v2.1.4
with:
path: venv
- key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
+ key:
+ ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
needs.prepare-tests-linux.outputs.python-key }}
- name: Fail job if Python cache restore failed
if: steps.cache-venv.outputs.cache-hit != 'true'
@@ -283,7 +286,8 @@ jobs:
uses: actions/cache@v2.1.4
with:
path: venv
- key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
+ key:
+ ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
needs.prepare-tests-linux.outputs.python-key }}
- name: Fail job if Python cache restore failed
if: steps.cache-venv.outputs.cache-hit != 'true'
@@ -307,11 +311,11 @@ jobs:
- name: Upload benchmark artifact
uses: actions/upload-artifact@v2.2.2
with:
- name: benchmark-${{ runner.os }}-${{ matrix.python-version }}_${{
+ name:
+ benchmark-${{ runner.os }}-${{ matrix.python-version }}_${{
steps.artifact-name-suffix.outputs.datetime }}
path: .benchmarks/
-
prepare-tests-windows:
name: Prepare tests for Python ${{ matrix.python-version }} (Windows)
runs-on: windows-latest
@@ -377,7 +381,8 @@ jobs:
uses: actions/cache@v2.1.4
with:
path: venv
- key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
+ key:
+ ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
needs.prepare-tests-windows.outputs.python-key }}
- name: Fail job if Python cache restore failed
if: steps.cache-venv.outputs.cache-hit != 'true'
@@ -389,7 +394,6 @@ jobs:
. venv\\Scripts\\activate
pytest --benchmark-disable tests/
-
prepare-tests-pypy:
name: Prepare tests for Python ${{ matrix.python-version }}
runs-on: ubuntu-latest
@@ -451,7 +455,8 @@ jobs:
uses: actions/cache@v2.1.4
with:
path: venv
- key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
+ key:
+ ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
needs.prepare-tests-pypy.outputs.python-key }}
- name: Fail job if Python cache restore failed
if: steps.cache-venv.outputs.cache-hit != 'true'