Skip to content

Conversation

@Grochocinski
Copy link
Collaborator

Linked Issue (Required)

Closes #174

Summary

Introduces a set of PR templates to standardize the contribution workflow

Proposed Changes

  • Add template menu (.github/pull_request_template) to act as a landing page, allowing users to select the proper template for their PR
  • Add solver (new_solver.md) and model/problem (new_model_problem.md) templates to give a baseline overview of new solvers/models/problems
  • Add a bug fix template (bug_fix.md) to mandate bug fix explanations and standardize testing
  • Add an enhancement template (enhancement.md) to provide a structure for general improvements and refactoring

Impact

  • Performance improvement
  • Code cleanup / Refactoring
  • Documentation update

Breaking Changes

  • No
  • Yes (Explain: )

Checklist

  • ruff check passes on my code
  • ty check passes on my code
  • My code follows the project's style guidelines
  • I have updated documentation as needed
  • I have added tests to cover the new logic

@Grochocinski Grochocinski added the enhancement New feature or request label Nov 26, 2025
@Grochocinski Grochocinski linked an issue Nov 26, 2025 that may be closed by this pull request
@Grochocinski Grochocinski marked this pull request as ready for review November 26, 2025 18:53
@Grochocinski Grochocinski self-assigned this Nov 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add PR Templates

2 participants