Skip to content

Add Issue templates#24

Open
h-chmeruk wants to merge 5 commits intomainfrom
add-issue-template
Open

Add Issue templates#24
h-chmeruk wants to merge 5 commits intomainfrom
add-issue-template

Conversation

@h-chmeruk
Copy link
Contributor

Which issue(s) are closed by this pull request?

Closes #19

Changes proposed in this pull request:

  • Added 4 different Issue templates which are based on the templates from this PR:
    • 01: Bug report
    • 02: Question
    • 03: Feature Request
    • 04: Documentation
  • Adjusted the test tests/test_copier/test_generated_file_exists to check the correct creation of new files.
  • Added new tests to check the content of the new files.

@h-chmeruk h-chmeruk added the enhancement New feature or request label Jan 23, 2026
@h-chmeruk h-chmeruk changed the title Add issue template Add Issue templates Jan 23, 2026
Copy link
Member

@ahms5 ahms5 left a comment

Choose a reason for hiding this comment

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

Thanks hanna, i have a few comments

@@ -0,0 +1,49 @@
name: 🐞 Bug report
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
name: 🐞 Bug report
name: Bug report

it was annoying me, the others dont have an icon :D

label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- label: I have searched the existing issues
- label: I looked for [similar issues](https://github.com/{{ git_username }}/{{ project_slug }}/issues).

maybe adapt similar to the question

options:
- label: I searched the [documentation](https://{{ project_slug }}.readthedocs.io).
required: true
- label: I looked through existing [discussion topics](https://github.com/pyfar/{{ project_slug }}/discussions).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- label: I looked through existing [discussion topics](https://github.com/pyfar/{{ project_slug }}/discussions).
- label: I looked through existing [discussion topics](https://github.com/{{ git_username }}/{{ project_slug }}/discussions).

required: true
- label: I looked through existing [discussion topics](https://github.com/pyfar/{{ project_slug }}/discussions).
required: true
- label: I looked for [similar issues](https://github.com/pyfar/{{ project_slug }}/issues).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- label: I looked for [similar issues](https://github.com/pyfar/{{ project_slug }}/issues).
- label: I looked for [similar issues](https://github.com/{{ git_username }/{{ project_slug }}/issues).

description: >
Please make sure you check all these items before submitting your feature request.
options:
- label: There are [no similar issues or pull requests](https://github.com/pyfar/{{ project_slug }}/issues) for this yet.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- label: There are [no similar issues or pull requests](https://github.com/pyfar/{{ project_slug }}/issues) for this yet.
- label: There are [no similar issues or pull requests](https://github.com/{{ git_username }/{{ project_slug }}/issues) for this yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the review!
There is also a link in 04-documentation.yml.jinja : https://pyfar-gallery.readthedocs.io/en/latest/examples.
I guess there's no point in replacing pyfar with {{ git_username }} in this link.
Should it stay as it is, or should I perhaps remove the link?

Copy link
Member

Choose a reason for hiding this comment

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

I think it should be replaced where ever it appears. this prevents bugs that might come up later.

I would leave the https://pyfar-gallery.readthedocs.io/en/latest/examples like as it is

@ahms5 ahms5 added this to the v0.1.0 milestone Feb 4, 2026
@ahms5 ahms5 added enhancement New feature or request and removed enhancement New feature or request labels Feb 4, 2026
def test_content_github_issue_template(default_project, file_name):
content = default_project.project_dir.joinpath(file_name).read_text()
desired = 'https://github.com/pyfar/my_project/issues'
assert desired in content, f"{desired!r} is not in content"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This function replaces the previous functions test_content_github_02_question() and test_content_github_03_feature_request() and additionally adds a check of the file .github/ISSUE_TEMPLATE/01-bug-report.yml.

@h-chmeruk h-chmeruk requested a review from ahms5 February 4, 2026 11:26
@github-project-automation github-project-automation bot moved this from Backlog to Require review in Weekly Planning Feb 6, 2026
Copy link
Member

@ahms5 ahms5 left a comment

Choose a reason for hiding this comment

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

looks fine to me, thanks. I would just remove the discussion point

Comment on lines +15 to +16
- label: I looked through existing [discussion topics](https://github.com/{{ git_username }}/{{ project_slug }}/discussions).
required: true
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- label: I looked through existing [discussion topics](https://github.com/{{ git_username }}/{{ project_slug }}/discussions).
required: true

we dont use discussions right now, so I would remove this point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

Status: Require review

Development

Successfully merging this pull request may close these issues.

add templates for issues

3 participants