Skip to content

Conversation

@karangattu
Copy link
Collaborator

@karangattu karangattu commented Feb 3, 2025

This pull request introduces new issue templates for bug reports, documentation issues, and feature requests to improve the process of reporting and managing issues in the Shiny for Python project. The most important changes include the addition of structured forms with required fields and detailed instructions to ensure comprehensive and clear issue submissions.

New way of user selecting which type of issue to create

Repo_Issues

New Issue Templates:

  • Bug Report Template:
    • Added a structured form to gather detailed information about bugs, including the affected component, severity, Shiny and Python versions, minimal reproducible example, current and expected behavior, error messages, environment information, and additional context.
New_Issue
  • Documentation Issue Template:
    • Introduced a template to report documentation issues or suggest improvements, with fields for documentation type, location, issue type, current content, suggested changes, motivation, additional context, and preliminary checks.
Cursor_and_New_Issue
  • Feature Request Template:
    • Created a form to suggest new features, including fields for feature category, scope, problem description, proposed solution, alternative solutions, example usage, expected impact, implementation considerations, complexity estimate, and preliminary checks.
New_Issue

@karangattu karangattu marked this pull request as ready for review February 11, 2025 17:29
@karangattu karangattu requested a review from schloerke February 11, 2025 17:30
@schloerke schloerke merged commit f8be541 into main Feb 27, 2025
41 checks passed
@schloerke schloerke deleted the add-issue-template branch February 27, 2025 19:48
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