diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4e331fa..13d191f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,33 +8,44 @@ type: Bug --- -**Describe the bug** -A clear and concise description of what the bug is. +## Describe the bug -**To Reproduce** -Steps to reproduce the behaviour: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +_A clear and concise description of the defect._ -**Expected behavior** -A clear and concise description of what you expected to happen. -**Terminal logs** -If applicable, upload a logfile of your terminal output to help explain your problem. +## Reproduction steps -**Environment (please complete the following information):** +1. _Update with reproduction steps_ + + +## Expected behavior + +_A clear and concise description of what you expected to happen._ + + +## Terminal logs + +_If applicable, upload a logfile of your terminal output to help explain your problem._ + + +## Environment - OS: [e.g. Debian Linux Trixie 13.4] - Python Version [e.g. 3.14.3] - Installation mechanism: - [ ] PyPI via `pip` - [ ] Built from Source - Paste result of `pip freeze` here: - ``` - > pip freeze - ... - ``` + ``` + > pip freeze + ... + ``` + - Paste **compiler version information** here: + ``` + > gcc --version + ... + ``` + + +## Additional context -**Additional context** -Add any other context about the problem here. +_Add any other context about the problem here, including issues or bugs on related projects and supporting documentation._ diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e255ea9..8f77b42 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,14 +8,22 @@ type: Feature --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +## Problem statement -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +_A clear and concise description of the problem._ -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. -**Additional context** -Add any other context or screenshots about the feature request here. +## Proposed solution + +_A clear and concise description of a proposed solution and how it resolves the problem._ + + +### Alternative solutions + +_A clear and concise description of any alternative solutions or features you've considered to resolve the problem._ + + +## Additional context + +_Add any other context, links to documentation, logs, or screenshots about the feature request here._ + diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/pull_request_template.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/pull_request_template.md rename to .github/pull_request_template.md diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index d6c9de5..95f0d1b 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -1,7 +1,11 @@ name: Python package -on: [pull_request, workflow_dispatch] - +on: + workflow_dispatch: + pull_request: + branches: [ '**' ] + paths-ignore: + - '**/*.md' jobs: build: