summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--.github/ISSUE_TEMPLATE/00_bug.yaml54
-rw-r--r--.github/ISSUE_TEMPLATE/01_feature.yaml38
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml8
3 files changed, 100 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/00_bug.yaml b/.github/ISSUE_TEMPLATE/00_bug.yaml
new file mode 100644
index 0000000..980f7af
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/00_bug.yaml
@@ -0,0 +1,54 @@
+name: bug report
+description: something went wrong
+body:
+ - type: markdown
+ attributes:
+ value: |
+ this is for issues for `pre-commit` (the framework).
+ if you are reporting an issue for [pre-commit.ci] please report it at [pre-commit-ci/issues]
+
+ [pre-commit.ci]: https://pre-commit.ci
+ [pre-commit-ci/issues]: https://github.com/pre-commit-ci/issues
+ - type: input
+ id: search
+ attributes:
+ label: search you tried in the issue tracker
+ placeholder: ...
+ validations:
+ required: true
+ - type: markdown
+ attributes:
+ value: |
+ 95% of issues created are duplicates.
+ please try extra hard to find them first.
+ it's very unlikely your problem is unique.
+ - type: textarea
+ id: freeform
+ attributes:
+ label: describe your issue
+ placeholder: 'I was doing ... I ran ... I expected ... I got ...'
+ validations:
+ required: true
+ - type: input
+ id: version
+ attributes:
+ label: pre-commit --version
+ placeholder: pre-commit x.x.x
+ validations:
+ required: true
+ - type: textarea
+ id: configuration
+ attributes:
+ label: .pre-commit-config.yaml
+ description: (auto-rendered as yaml, no need for backticks)
+ placeholder: 'repos: ...'
+ render: yaml
+ validations:
+ required: true
+ - type: textarea
+ id: error-log
+ attributes:
+ label: '~/.cache/pre-commit/pre-commit.log (if present)'
+ placeholder: "### version information\n..."
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/01_feature.yaml b/.github/ISSUE_TEMPLATE/01_feature.yaml
new file mode 100644
index 0000000..c7ddc84
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/01_feature.yaml
@@ -0,0 +1,38 @@
+name: feature request
+description: something new
+body:
+ - type: markdown
+ attributes:
+ value: |
+ this is for issues for `pre-commit` (the framework).
+ if you are reporting an issue for [pre-commit.ci] please report it at [pre-commit-ci/issues]
+
+ [pre-commit.ci]: https://pre-commit.ci
+ [pre-commit-ci/issues]: https://github.com/pre-commit-ci/issues
+ - type: input
+ id: search
+ attributes:
+ label: search you tried in the issue tracker
+ placeholder: ...
+ validations:
+ required: true
+ - type: markdown
+ attributes:
+ value: |
+ 95% of issues created are duplicates.
+ please try extra hard to find them first.
+ it's very unlikely your feature idea is a new one.
+ - type: textarea
+ id: freeform
+ attributes:
+ label: describe your actual problem
+ placeholder: 'I want to do ... I tried ... It does not work because ...'
+ validations:
+ required: true
+ - type: input
+ id: version
+ attributes:
+ label: pre-commit --version
+ placeholder: pre-commit x.x.x
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..4179f47
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+- name: documentation
+ url: https://pre-commit.com
+ about: please check the docs first
+- name: pre-commit.ci issues
+ url: https://github.com/pre-commit-ci/issues
+ about: please report issues about pre-commit.ci here