-
-
Notifications
You must be signed in to change notification settings - Fork 96
Labels
component/integrationWeb framework integrationWeb framework integrationpriority/mediumMedium priority issuesMedium priority issuestype/documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Problem
Currently, the project doesn’t seem to have issue or pull request templates. This can make it harder to share context consistently between contributors.
Proposed Solution
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates
GitHub provides built-in support via .github/ISSUE_TEMPLATE/ and .github/PULL_REQUEST_TEMPLATE.md, so setup should be straightforward.
Benefits
Introducing standardized templates would bring several benefits:
- Clearer issue reports with reproducible steps and expected behavior
- Structured PR descriptions outlining changes, scope, and testing
- Easier and faster reviews thanks to consistent context
Implementation Considerations
- Checklist in PR template:
Include a checklist for common review points (e.g., tests added, documentation updated, CI passing) to improve consistency and completeness. - Contributor guidance:
Provide brief instructions or tips in each template to help new contributors understand what information is expected. - Minimal friction:
Keep the templates concise and to the point to encourage contributors to use them instead of skipping or removing sections.
Additional Comments
If you’ve already used or are familiar with a good template, feel free to share it!
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
component/integrationWeb framework integrationWeb framework integrationpriority/mediumMedium priority issuesMedium priority issuestype/documentationImprovements or additions to documentationImprovements or additions to documentation