diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 75b7f2d7..8200f50c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,110 +1,98 @@ # Feature Pull Request ## Branch Naming Convention - - - -Current branch: `` + +Current branch: BRANCH_NAME ## Related Issue - - -Closes # + +Closes #ISSUE_NUMBER ## Feature Description - ## Implementation Details + +**Important Notes (please address or acknowledge):** + ## Changes Made - + -- -- -- ## Testing Performed - - + -## Pre-commit and Testing Instructions - +## Testing Instructions + -**Running Pre-commit Hooks:** -```bash -# These are basic defaults for testing. -# Please adjust as needed for complete testing of your changes +**Common Testing Instructions** -# Install pre-commit if not already installed -just pre-commit-setup +To ensure code quality and consistency before submitting: -# Run pre-commit on all files -just pre-commit-run -``` +**Install the package in editable mode with development dependencies** + +```just install-dev``` + +**Run pre-commit checks on all files** + +```just pre-commit-run``` + +**Run all tests (Note: The `just test` command is a project-specific test runner.)** + +```just test``` + +**To run linting checks** + +```just lint``` + + **To run code formatting** + +```just format``` + +**Install new dependencies or tools (if added):** + +If this PR adds new dependencies or tools, install them using the project’s recommended method (Justfile): -**Running Tests:** ```bash -# Run all tests -just test -# Note: The `just test` command is a project-specific command for running tests. -# Please refer to the project documentation or the CONTRIBUTING.md file for setup instructions. +# Example installation command (replace with the actual one) +just install-[tool-name] ``` - ---> +**Testing just commands for new dependencies or tools (if added):** +- ```just A``` # To test the A functionality +- ```just B``` # To test the B functionality ## Documentation Updates - - + - -## Breaking Changes - - - +- ## Checklist -- [ ] Branch name follows convention (`feature/description` or `feature/issue-number-description`) - [ ] Testing added to pre-commit hook (`pre-commit run --all-files` passes) -- [ ] Testing added to CI/CD pipeline in GitHub Actions +- [ ] All tests pass locally and in CI - [ ] Documentation added/updated in Sphinx - [ ] Appropriate unit test coverage added (run `pytest --cov` to verify) -- [ ] New commands added to CLI (if applicable) -- [ ] Code follows project style guidelines (`flake8` or equivalent passes) -- [ ] All tests pass locally and in CI - [ ] Self-review of code performed - [ ] No debug print statements or commented-out code left in the codebase - -## Reviewer Notes - - -