Revise issue templates #90

ahms5 · 2025-10-27T13:33:15Z

Changes proposed in this pull request:

used issue templates from https://github.com/pyOpenSci/pyos-package-template
remove previous issue template
add install hint for depinfo
rename title prefix for enhancement to [ENH]

.github/ISSUE_TEMPLATE/config.yml

ahms5 · 2025-10-27T13:38:50Z

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true


maybe this is required for creatung subissues?

Copilot

Pull Request Overview

This pull request modernizes the issue reporting workflow by replacing the old markdown-based issue template with structured YAML templates from pyOpenSci's package template. The update provides specific forms for different issue types (bugs, questions, feature requests) with guided input fields.

Key changes:

Added structured YAML templates for bug reports, questions, and feature requests with required checklists and validation
Configured community support links directing users to GitHub Discussions
Enhanced bug report template to include depinfo installation instructions for better environment reporting

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
.github/ISSUE_TEMPLATE.md	Removed the old generic markdown issue template
.github/ISSUE_TEMPLATE/config.yml	Added configuration enabling blank issues and directing questions to discussions
.github/ISSUE_TEMPLATE/01-bug-report.yml	Added structured bug report form with environment details and code sample fields
.github/ISSUE_TEMPLATE/02-question.yml	Added question template with checklist to verify documentation/search attempts
.github/ISSUE_TEMPLATE/03-feature-request.yml	Added feature request form with problem/solution/alternatives structure

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

sikersten

Thanks for taking care!

.github/ISSUE_TEMPLATE/01-bug-report.yml

sikersten · 2025-10-27T14:02:28Z

.github/ISSUE_TEMPLATE/01-bug-report.yml

+    attributes:
+      label: Environment
+      description: >
+        Please paste the output of running `depinfo --markdown pyrato`


I tested depinfo with pyfar an get some "missing" statements. Could it be that depinfo uses the dev requirements as checklist?

pytest-cov missing ruff 0.6.3 scipy 1.11.3 setuptools 68.0.0 sofar 1.1.1 soundfile 0.12.1 sphinx missing sphinx-design missing sphinx-favicon missing sphinx-mdinclude missing sphinx-reredirects missing twine missing urllib3 2.1.0 watchdog missing wheel 0.41.2 Build Tools Information ----------------------- pip 23.3 setuptools 68.0.0 wheel 0.41.2 Platform Information -------------------- Windows 10-AMD64 CPython 3.11.5

I've tried to find some documentation on that, but it does not seem that the project provides any apart from the README on GitHub

sikersten · 2025-10-27T14:02:56Z

.github/ISSUE_TEMPLATE/01-bug-report.yml

+      description: >
+        Please paste the output of running `depinfo --markdown pyrato`
+        in your environment between the `details` tags below.
+        If you have not installed `depinfo`, you can install it via `pip install depinfo`.


Should we add depinfo to the requirements?

It also seems that the package is no longer maintained. The last officially supported python version is 3.11. Not sure if we want to have something like that as dependency.

how about using sth like pip list --local instead

or pipdeptree instead
pipdeptree --package pyfar
this seems to be maintained

pyfar==0.7.3 ├── numpy [required: >=1.23.0, installed: 2.3.3] ├── scipy [required: >=1.5.0, installed: 1.16.2] │ └── numpy [required: >=1.25.2,<2.6, installed: 2.3.3] ├── matplotlib [required: Any, installed: 3.10.6] │ ├── contourpy [required: >=1.0.1, installed: 1.3.3] │ │ └── numpy [required: >=1.25, installed: 2.3.3] │ ├── cycler [required: >=0.10, installed: 0.12.1] │ ├── fonttools [required: >=4.22.0, installed: 4.60.1] │ ├── kiwisolver [required: >=1.3.1, installed: 1.4.9] │ ├── numpy [required: >=1.23, installed: 2.3.3] │ ├── packaging [required: >=20.0, installed: 25.0] │ ├── pillow [required: >=8, installed: 11.3.0] │ ├── pyparsing [required: >=2.3.1, installed: 3.2.5] │ └── python-dateutil [required: >=2.7, installed: 2.9.0.post0] │ └── six [required: >=1.5, installed: 1.17.0] ├── sofar [required: >=0.1.2, installed: 1.2.2] │ ├── netCDF4 [required: Any, installed: 1.7.2] │ │ ├── cftime [required: Any, installed: 1.6.4.post1] │ │ │ └── numpy [required: >=1.26.0b1, installed: 2.3.3] │ │ ├── certifi [required: Any, installed: 2025.10.5] │ │ └── numpy [required: Any, installed: 2.3.3] │ ├── numpy [required: >=1.14.0, installed: 2.3.3] │ ├── beautifulsoup4 [required: Any, installed: 4.14.2] │ │ ├── soupsieve [required: >1.2, installed: 2.8] │ │ └── typing_extensions [required: >=4.0.0, installed: 4.15.0] │ ├── requests [required: Any, installed: 2.32.5] │ │ ├── charset-normalizer [required: >=2,<4, installed: 3.4.3] │ │ ├── idna [required: >=2.5,<4, installed: 3.10] │ │ ├── urllib3 [required: >=1.21.1,<3, installed: 2.5.0] │ │ └── certifi [required: >=2017.4.17, installed: 2025.10.5] │ └── packaging [required: Any, installed: 25.0] ├── urllib3 [required: Any, installed: 2.5.0] ├── deepdiff [required: Any, installed: 8.6.1] │ └── orderly-set [required: >=5.4.1,<6, installed: 5.5.0] └── soundfile [required: >=0.11.0, installed: 0.13.1] ├── cffi [required: >=1.0, installed: 2.0.0] │ └── pycparser [required: Any, installed: 2.23] └── numpy [required: Any, installed: 2.3.3]

Do you know how the package works? Does it only resolve packages and dependencies installed via pip?
The name suggests that it does at least.

good qestion, its dependency is pip and package, so i think it used pip.
I tried it with uv uv run pipdeptree --package pyfar and it is working.
in the venv it is also working with source .venv/bin/activate && pipdeptree --package pyfar

have you checked if it lists packages which were not installed through pip? (conda for example)

yes, I have just tested it.

Cool. Then let's keep it!

.github/ISSUE_TEMPLATE/config.yml

Co-authored-by: sikersten <70263411+sikersten@users.noreply.github.com>

ahms5 · 2025-10-30T08:42:06Z

.github/ISSUE_TEMPLATE/01-bug-report.yml

+        <details>
+
+        ```text
+        Paste output of `pipdeptree --package pyrato` here
+
+        ```
+
+        </details>


i have adapted this, in this way to output would look like this:

Details

pyrato==0.4.1 ├── pyfar [required: >=0.5.0, installed: 0.7.3] │ ├── numpy [required: >=1.23.0, installed: 2.3.3] │ ├── scipy [required: >=1.5.0, installed: 1.16.2] │ │ └── numpy [required: >=1.25.2,<2.6, installed: 2.3.3] │ ├── matplotlib [required: Any, installed: 3.10.6] │ │ ├── contourpy [required: >=1.0.1, installed: 1.3.3] │ │ │ └── numpy [required: >=1.25, installed: 2.3.3] │ │ ├── cycler [required: >=0.10, installed: 0.12.1] │ │ ├── fonttools [required: >=4.22.0, installed: 4.59.2] │ │ ├── kiwisolver [required: >=1.3.1, installed: 1.4.9] │ │ ├── numpy [required: >=1.23, installed: 2.3.3] │ │ ├── packaging [required: >=20.0, installed: 25.0] │ │ ├── pillow [required: >=8, installed: 11.3.0] │ │ ├── pyparsing [required: >=2.3.1, installed: 3.2.4] │ │ └── python-dateutil [required: >=2.7, installed: 2.9.0.post0] │ │ └── six [required: >=1.5, installed: 1.17.0] │ ├── sofar [required: >=0.1.2, installed: 1.2.2] │ │ ├── netCDF4 [required: Any, installed: 1.7.2] │ │ │ ├── cftime [required: Any, installed: 1.6.4.post1] │ │ │ │ └── numpy [required: >=1.26.0b1, installed: 2.3.3] │ │ │ ├── certifi [required: Any, installed: 2025.8.3] │ │ │ └── numpy [required: Any, installed: 2.3.3] │ │ ├── numpy [required: >=1.14.0, installed: 2.3.3] │ │ ├── beautifulsoup4 [required: Any, installed: 4.13.5] │ │ │ ├── soupsieve [required: >1.2, installed: 2.8] │ │ │ └── typing_extensions [required: >=4.0.0, installed: 4.15.0] │ │ ├── requests [required: Any, installed: 2.32.5] │ │ │ ├── charset-normalizer [required: >=2,<4, installed: 3.4.3] │ │ │ ├── idna [required: >=2.5,<4, installed: 3.10] │ │ │ ├── urllib3 [required: >=1.21.1,<3, installed: 2.5.0] │ │ │ └── certifi [required: >=2017.4.17, installed: 2025.8.3] │ │ └── packaging [required: Any, installed: 25.0] │ ├── urllib3 [required: Any, installed: 2.5.0] │ ├── deepdiff [required: Any, installed: 8.6.1] │ │ └── orderly-set [required: >=5.4.1,<6, installed: 5.5.0] │ └── soundfile [required: >=0.11.0, installed: 0.13.1] │ ├── cffi [required: >=1.0, installed: 2.0.0] │ │ └── pycparser [required: Any, installed: 2.23] │ └── numpy [required: Any, installed: 2.3.3] ├── numpy [required: >=1.14.0, installed: 2.3.3] ├── scipy [required: >=1.5.0, installed: 1.16.2] │ └── numpy [required: >=1.25.2,<2.6, installed: 2.3.3] └── matplotlib [required: Any, installed: 3.10.6] ├── contourpy [required: >=1.0.1, installed: 1.3.3] │ └── numpy [required: >=1.25, installed: 2.3.3] ├── cycler [required: >=0.10, installed: 0.12.1] ├── fonttools [required: >=4.22.0, installed: 4.59.2] ├── kiwisolver [required: >=1.3.1, installed: 1.4.9] ├── numpy [required: >=1.23, installed: 2.3.3] ├── packaging [required: >=20.0, installed: 25.0] ├── pillow [required: >=8, installed: 11.3.0] ├── pyparsing [required: >=2.3.1, installed: 3.2.4] └── python-dateutil [required: >=2.7, installed: 2.9.0.post0] └── six [required: >=1.5, installed: 1.17.0]

ahms5 · 2025-10-30T09:27:46Z

added tempalte for documentation issues based in the numpy tempalte

sikersten

Thanks! Should we align the placeholders?

sikersten · 2025-10-30T10:01:59Z

.github/ISSUE_TEMPLATE/03-feature-request.yml

@@ -0,0 +1,49 @@
+name: Feature request
+description: Suggest an idea for this project
+title: "[ENH] "


Align with DOC?

Suggested change

title: "[ENH] "

title: "[ENH] <Please write a comprehensive title after the 'ENH: ' prefix>"

sikersten · 2025-10-30T10:02:30Z

.github/ISSUE_TEMPLATE/02-question.yml

@@ -0,0 +1,27 @@
+name: Question
+description: Ask a question
+title: "[Question] "


Align with DOC?

Suggested change

title: "[Question] "

title: "[Question] <Please write a comprehensive title after the 'Question: ' prefix>"

sikersten · 2025-10-30T10:02:58Z

.github/ISSUE_TEMPLATE/01-bug-report.yml

@@ -0,0 +1,74 @@
+name: 🐞 Bug report
+description: Report a problem to help improve this project
+title: "[BUG] "


Align with DOC?

Suggested change

title: "[BUG] "

title: "[BUG] <Please write a comprehensive title after the 'BUG: ' prefix>"

sikersten · 2025-10-30T12:38:36Z

.github/ISSUE_TEMPLATE/01-bug-report.yml

@@ -0,0 +1,74 @@
+name: 🐞 Bug report
+description: Report a problem to help improve this project
+title: "[BUG] <Please write a comprehensive title after the '[BUG] ' prefix>"


How I understand is, the title will then be "[BUG] Title of the issue". Is this intended? Numpy style would be "BUG: Title of the issue". I'm fine with both.

maybe, but @mberz started this style, https://github.com/pyfar/pyrato/issues
both would work for me

init commit from https://github.com/pyOpenSci/pyos-package-template

4dafae1

ahms5 self-assigned this Oct 27, 2025

ahms5 added 2 commits October 27, 2025 14:33

remove previous issue template

dfc7aac

add install hint

f3dd020

ahms5 added this to the v0.4.2 milestone Oct 27, 2025

ahms5 added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 27, 2025

rename title prefix for enhancement to [ENH]

98f192e

ahms5 commented Oct 27, 2025

View reviewed changes

.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved

ahms5 commented Oct 27, 2025

View reviewed changes

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@

blank_issues_enabled: true

Copy link

Member Author

ahms5 Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe this is required for creatung subissues?

ahms5 requested review from Copilot, mberz and sikersten October 27, 2025 13:39

Copilot AI reviewed Oct 27, 2025

View reviewed changes

ahms5 changed the title ~~Add issue templates~~ Revise issue templates Oct 27, 2025

ahms5 assigned mberz and sikersten Oct 27, 2025

sikersten reviewed Oct 27, 2025

View reviewed changes

ahms5 commented Oct 28, 2025

View reviewed changes

.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved

ahms5 and others added 4 commits October 28, 2025 09:42

Apply suggestions from code review

30d37e0

Co-authored-by: sikersten <70263411+sikersten@users.noreply.github.com>

change to pipdeptree

1fa6ff4

force test output, otherwise format will fail

2ed1b8b

remove open

90afcb6

ahms5 commented Oct 30, 2025

View reviewed changes

ahms5 requested a review from sikersten October 30, 2025 08:42

add documentation issue template

a801d17

sikersten reviewed Oct 30, 2025

View reviewed changes

add suggestions by @sikersten

7d50396

ahms5 requested a review from sikersten October 30, 2025 12:16

sikersten reviewed Oct 30, 2025

View reviewed changes

This was referenced Oct 30, 2025

automatically add the project to this issue #92

Merged

Enhance general contribution guidelines pyfar/gallery#114

Merged

mberz approved these changes Oct 31, 2025

View reviewed changes

automatically add the project to issues (#92)

bc0dcf6

mberz merged commit 3fb1352 into main Oct 31, 2025
12 checks passed

mberz deleted the issue_templates branch October 31, 2025 10:50

ahms5 mentioned this pull request Jan 9, 2026

add templates for issues pyfar/template-pyfar-package#19

Open

h-chmeruk mentioned this pull request Jan 23, 2026

Add Issue templates pyfar/template-pyfar-package#24

Open

	title: "[ENH] "
	title: "[ENH] <Please write a comprehensive title after the 'ENH: ' prefix>"

	title: "[Question] "
	title: "[Question] <Please write a comprehensive title after the 'Question: ' prefix>"

	title: "[BUG] "
	title: "[BUG] <Please write a comprehensive title after the 'BUG: ' prefix>"

Revise issue templates #90

Revise issue templates #90

Uh oh!

Conversation

ahms5 commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes proposed in this pull request:

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

sikersten left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ahms5 Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ahms5 commented Oct 30, 2025

Uh oh!

sikersten left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sikersten Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ahms5 commented Oct 27, 2025 •

edited

Loading

ahms5 Oct 29, 2025 •

edited

Loading

sikersten Oct 30, 2025 •

edited

Loading