Skip to content

Commit

Permalink
DX: switch to issue forms
Browse files Browse the repository at this point in the history
  • Loading branch information
redeboer committed Sep 28, 2023
1 parent e531069 commit 466706a
Show file tree
Hide file tree
Showing 8 changed files with 129 additions and 60 deletions.
2 changes: 1 addition & 1 deletion .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
".readthedocs.yml",
".vscode/*",
".vscode/.gitignore",
".zenodo.json",
"CITATION.cff",
"codecov.yml",
"Dockerfile",
"docs/_templates/*",
Expand Down
77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: Bug Report
description: File a bug report
labels:
- 🐛 Bug
assignees:
# cspell: ignore redeboer shenvitor
- redeboer
- shenvitor
projects:
- ComPWA/5

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Is there any log output (such as raised exceptions) you can share?
placeholder: Place any log output here
render: plain text

- type: textarea
id: code-snippet
attributes:
label: Is it possible to reproduce the bug with a small code snippet?
description: Ideally, post a small snippet of code that can reproduce the bug, including `import` statements.
placeholder: Paste your Python code here
render: python3

- type: textarea
id: reproduction
attributes:
label: Additional steps to reproduce the bug
description: Where there any additional steps you took that led up to the bug?
placeholder: Fill this out in particular if it is hard to provide a code snippet that reproduces the bug.

- type: dropdown
id: python-version
attributes:
label: Which Python version were you using?
description: |
You can check this with
```shell
python3 --version
```
options:
- Python 3.6
- Python 3.7
- Python 3.8
- Python 3.9
- Python 3.10
- Python 3.11
- Python 3.12

- type: textarea
id: pip-freeze
attributes:
label: Python dependencies
description: |
If the bug is caused by a Python package, please run the following command and paste the output here:
```shell
python3 -m pip freeze
````
placeholder: Paste the output of pip freeze here
render: plain text
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Feature request
description: Suggest an idea for this project
labels:
- ✨ Feature
assignees:
# cspell: ignore redeboer shenvitor
- redeboer
- shenvitor
projects:
- ComPWA/5

body:
- type: textarea
id: problem-description
attributes:
label: Problem description
description: >-
Is your feature request related to a problem?
Please provide a clear and concise description of what the problem is.
placeholder: |
Example: I'm always frustrated when ...
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: Proposed solution
description: Describe the solution you'd want to happen. Are there alternatives you have considered?
placeholder: |
I would like to see ...
validations:
required: true

- type: textarea
id: code-snippet
attributes:
label: What should the interface look like?
description: If you already have some ideas, write some code snippets that describe the interface behavior you would like to see!
placeholder: Write your Python code here
render: python3

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature here.
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

3 changes: 2 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@ repos:
- id: trailing-whitespace

- repo: https://github.com/ComPWA/repo-maintenance
rev: 0.0.192
rev: 49c9204
hooks:
- id: check-dev-files
args:
- --keep-issue-templates
- --no-prettierrc
- --no-python
- --repo-name=compwa-github
Expand Down
1 change: 1 addition & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"streetsidesoftware.code-spell-checker"
],
"unwantedRecommendations": [
"davidanson.vscode-markdownlint",
"ms-python.flake8",
"ms-python.isort",
"ms-python.pylint",
Expand Down
5 changes: 1 addition & 4 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
{
"editor.formatOnSave": true,
"python.linting.flake8Enabled": false,
"python.linting.pydocstyleEnabled": false,
"python.linting.pylintEnabled": false
"editor.formatOnSave": true
}

0 comments on commit 466706a

Please sign in to comment.