diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fafcec8e1..02bb9b79a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,12 @@ +## Proposed changes -Before submitting this PR, check the [contribution guidelines](CONTRIBUTING.md). +Please include a description of the problem or feature this PR is addressing. If there is a corresponding issue, include the issue #. -Make sure your code is formatted: `pre-commit run --all-files`. +## Checklist + +Put an `x` in the boxes that apply. + +- [ ] I have read the [CONTRIBUTING](https://github.com/ml-explore/mlx/blob/main/CONTRIBUTING.md) document +- [ ] I have run `pre-commit run --all-files` to format my code / installed pre-commit prior to committing changes +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] I have updated the necessary documentation (if needed)