Skip to content

Issue templates refactor#714

Merged
AdrianDAlessandro merged 3 commits into
cw26-hack-dayfrom
issue-templates-refactor
Apr 30, 2026
Merged

Issue templates refactor#714
AdrianDAlessandro merged 3 commits into
cw26-hack-dayfrom
issue-templates-refactor

Conversation

@TinyMarsh
Copy link
Copy Markdown
Contributor

@TinyMarsh TinyMarsh commented Apr 30, 2026

Description

Not sure if this is what the objective was for this, but I've had a goo at making some constructive changes.

Updates the GitHub issue templates for bug reports, feature requests, and technical work. The main changes involve migrating from legacy Markdown templates to the new YAML-based issue forms.

  • Replaced the old Markdown-based feature_request.md and technical_work.md templates with new YAML-based forms (feature_request.yml and technical_work.yml), just providing some more structure really.
  • Made some changes to the "Environment" section in the bug report template to clarify which details are required for all users and which are optional for developers.
  • Updated the feature request template to include a required checkbox for searching existing issues.

Fixes #712

Type of change

  • Documentation (non-breaking change that adds or improves the documentation)
  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Technical work (non-breaking, change which is work as part of a new feature)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass (eg. python -m pytest)
  • The documentation builds and looks OK (eg. mkdocs serve)
  • Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@AdrianDAlessandro AdrianDAlessandro mentioned this pull request Apr 30, 2026
11 tasks
Copy link
Copy Markdown

@elichad elichad left a comment

Choose a reason for hiding this comment

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

Looks good to me :)

Copy link
Copy Markdown
Collaborator

@AdrianDAlessandro AdrianDAlessandro left a comment

Choose a reason for hiding this comment

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

LGTM!

@AdrianDAlessandro AdrianDAlessandro merged commit bd82991 into cw26-hack-day Apr 30, 2026
5 checks passed
@AdrianDAlessandro AdrianDAlessandro deleted the issue-templates-refactor branch April 30, 2026 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants