diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 365305d..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,33 +0,0 @@ -Please read this brief portion of documentation before going any further: http://flake8.pycqa.org/en/latest/internal/contributing.html#filing-a-bug - - - - -*Please describe how you installed Flake8* - -Example: - -``` -$ pip install --user flake8 -$ brew install flake8 -# etc. -``` - -**Note**: Some *nix distributions patch Flake8 arbitrarily to accommodate incompatible software versions. If you're on one of those distributions, your issue may be closed and you will be asked to open an issue with your distribution package maintainers instead. - -*Please provide the exact, unmodified output of `flake8 --bug-report`* - -*Please describe the problem or feature* - -*If this is a bug report, please explain with examples (and example code) what you expected to happen and what actually happened.* diff --git a/.github/ISSUE_TEMPLATE/01_bug.yml b/.github/ISSUE_TEMPLATE/01_bug.yml new file mode 100644 index 0000000..0f95e80 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_bug.yml @@ -0,0 +1,86 @@ +name: bug report +description: something went wrong +body: + - type: markdown + attributes: + value: > + Please read this brief portion of documentation before going any + further: + http://flake8.pycqa.org/en/latest/internal/contributing.html#filing-a-bug + + - type: markdown + attributes: + value: > + **NOTE: flake8 is a linting framework and does not implement any + checks** + + - type: markdown + attributes: + value: > + _if you are reporting a problem with a particular check, please track + down the plugin which implements that check_ + + - type: textarea + id: install + attributes: + label: how did you install flake8? + description: 'note: this will be rendered as ```console automatically' + placeholder: | + $ pip install flake8 # or `brew install flake8` etc. + Collecting flake8 + ... + Successfully installed flake8... + render: console + validations: + required: true + + - type: markdown + attributes: + value: > + **Note**: Some *nix distributions patch Flake8 arbitrarily to + accommodate incompatible software versions. If you're on one of those + distributions, your issue may be closed and you will be asked to open + an issue with your distribution package maintainers instead. + + - type: textarea + id: bug-report + attributes: + label: unmodified output of `flake8 --bug-report` + description: 'note: this will be rendered as ```json automatically' + placeholder: | + { + "platform": { + "...": "... + } + } + render: json + validations: + required: true + + - type: textarea + id: freeform + attributes: + label: describe the problem + description: > + please provide **sample code** and **directions for reproducing + your problem** including the **commands you ran**, their + **unedited output**, and **what you expected to happen** + value: | + #### what I expected to happen + + ... + + #### sample code + + ```python + print('hello world!') + ``` + + #### commands ran + + ```console + $ flake8 t.py + ... + ``` + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/02_feature.yml b/.github/ISSUE_TEMPLATE/02_feature.yml new file mode 100644 index 0000000..99cc4e2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_feature.yml @@ -0,0 +1,19 @@ +name: feature request +description: a new feature! +body: + - type: markdown + attributes: + value: > + Please read this brief portion of documentation before going any + further: + http://flake8.pycqa.org/en/latest/internal/contributing.html#filing-a-bug + + - type: textarea + id: freeform + attributes: + label: describe the request + description: > + please describe your use case and why the current feature set does + not satisfy your needs + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..44fec6d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: problem with E___ or W___ codes + url: https://github.com/PyCQA/pycodestyle/issues + about: flake8 does not implement any checks, perhaps you want pycodestyle? + - name: problem with F___ codes + url: https://github.com/PyCQA/pyflakes/issues + about: flake8 does not implement any checks, perhaps you want pyflakes? + - name: problem with C___ codes + url: https://github.com/PyCQA/mccabe/issues + about: flake8 does not implement any checks, perhaps you want mccabe?