Skip to content

Fix inconsistencies in issue_template.md and MR_template.md

Description

While working with the current contribution templates, I noticed a few areas that could be improved for clarity, accuracy, and ease of use. Updating these templates will help streamline contributions and better reflect our actual development practices.

Suggested Improvements

1. merge_request_template.md

  • Remove the line: “Follows Semantic Versioning” — this seems unnecessary and may not be applicable to all changes.

2. issue_template.md

  • Issue Type: Recommend removing this section and instead guiding users to apply the appropriate label.
  • Environment Table: The Python version listed may be outdated or incorrect — this should be updated to reflect the supported version(s).
  • Proposed Solution: Suggest removing the "Expected version bump" field, as it’s often not needed or relevant for all issues.
  • Checklist: Propose removing the following checklist items for simplicity:
    • I have read the Contributing Guidelines
    • My issue follows semantic versioning guidelines (e.g., MAJOR, MINOR, PATCH)