Skip to content

Conversation

@harryswift01
Copy link
Contributor

@harryswift01 harryswift01 commented Jan 15, 2026

Summary

This PR will add GitHub issue templates for Bug Reports and Feature Requests, including structured sections, placeholders, and guidance for YAML/CLI workflows. These templates improve consistency and reproducibility for contributors submitting bugs or feature requests.

Changes

Add Bug Report Template:

  • Created .github/ISSUE_TEMPLATE/bug_report.md
  • Structured sections: Describe the bug, To Reproduce (YAML + CLI), Actual vs Expected output, Environment, Screenshots/Logs, Additional Context
  • Included placeholders and tips for minimal reproducible YAML examples

Add Feature Request Template:

  • Created .github/ISSUE_TEMPLATE/feature_request.md
  • Structured sections: Problem/Motivation, Proposed Solution, Alternatives Considered, Expected Impact, Additional Context
  • Added guidance for examples, optional YAML/CLI snippets, and placeholders for contributors

Impact

  • Contributors will have clear guidance for submitting reproducible bug reports and well-structured feature requests
  • Maintainers will spend less time clarifying issues or requests
  • Improves overall workflow and repository contribution quality

@harryswift01 harryswift01 self-assigned this Jan 15, 2026
@harryswift01 harryswift01 requested a review from jimboid January 15, 2026 11:58
Copy link
Member

@jimboid jimboid left a comment

Choose a reason for hiding this comment

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

Hi Harry, looking great.

Can you add to the environment and versions to append a dump of either

conda packages using "conda list" or if using venv then "pip list"

@harryswift01 harryswift01 requested a review from jimboid January 15, 2026 12:12
@harryswift01
Copy link
Contributor Author

Hi Harry, looking great.

Can you add to the environment and versions to append a dump of either

conda packages using "conda list" or if using venv then "pip list"

That's a great spot, thank you! I've just added that in now.

Copy link
Member

@jimboid jimboid left a comment

Choose a reason for hiding this comment

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

Looks great. A nice addition to the repo and will help with long term handling of requests and reports.

@harryswift01 harryswift01 merged commit 6c126a2 into main Jan 15, 2026
15 checks passed
@harryswift01 harryswift01 deleted the harryswift01-patch-1 branch January 15, 2026 12:15
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