From ce5f751b7ed07529fd3a61b957f5141aca577df8 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Thu, 28 Sep 2023 22:27:32 +0200 Subject: [PATCH 1/2] DX: sync ComPWA dev setup --- .cspell.json | 2 +- .pre-commit-config.yaml | 2 +- .vscode/extensions.json | 1 + .vscode/settings.json | 5 +---- 4 files changed, 4 insertions(+), 6 deletions(-) diff --git a/.cspell.json b/.cspell.json index f7a52f4..eaeb12e 100644 --- a/.cspell.json +++ b/.cspell.json @@ -32,7 +32,7 @@ ".readthedocs.yml", ".vscode/*", ".vscode/.gitignore", - ".zenodo.json", + "CITATION.cff", "codecov.yml", "Dockerfile", "docs/_templates/*", diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 68d26a5..0b3f201 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -20,7 +20,7 @@ repos: - id: trailing-whitespace - repo: https://github.com/ComPWA/repo-maintenance - rev: 0.0.192 + rev: 0.0.199 hooks: - id: check-dev-files args: diff --git a/.vscode/extensions.json b/.vscode/extensions.json index a5336c2..4c15c5f 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -6,6 +6,7 @@ "streetsidesoftware.code-spell-checker" ], "unwantedRecommendations": [ + "davidanson.vscode-markdownlint", "ms-python.flake8", "ms-python.isort", "ms-python.pylint", diff --git a/.vscode/settings.json b/.vscode/settings.json index 4554c18..ad92582 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,6 +1,3 @@ { - "editor.formatOnSave": true, - "python.linting.flake8Enabled": false, - "python.linting.pydocstyleEnabled": false, - "python.linting.pylintEnabled": false + "editor.formatOnSave": true } From 6788e5bcfaf5dc6fc9b9b933d93024bcac391427 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Thu, 28 Sep 2023 21:36:12 +0200 Subject: [PATCH 2/2] DX: switch to issue forms https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms --- .github/ISSUE_TEMPLATE/bug-report.yml | 77 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 32 --------- .github/ISSUE_TEMPLATE/feature-request.yml | 47 +++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 22 ------- .pre-commit-config.yaml | 3 +- 5 files changed, 126 insertions(+), 55 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..c766ffc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d0cc61c..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "" -labels: Bug -assignees: "" ---- - -## Bug description - - - - - -## How to reproduce? - -Steps to reproduce the behavior: - -1. - -## Expected behavior - - - -## System info - -Bug resulted on the following system: - -- OS: -- Version -- Python version: -- Virtual environment: diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..15b00f4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 049eb32..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "" -labels: "✨ Enhancement" -assignees: "" ---- - -## Problem description - - - -## Proposed solution - - - - - - - diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0b3f201..ad40b85 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -20,10 +20,11 @@ repos: - id: trailing-whitespace - repo: https://github.com/ComPWA/repo-maintenance - rev: 0.0.199 + rev: 0.0.200 hooks: - id: check-dev-files args: + - --keep-issue-templates - --no-prettierrc - --no-python - --repo-name=compwa-github