From 0d9b05aa61253180653d9f734d18a6f2526fedc1 Mon Sep 17 00:00:00 2001 From: Javier Chavarri Date: Tue, 17 Oct 2023 17:06:57 +0000 Subject: [PATCH] add pr template --- .github/pull_request_template.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..18d3b83 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,21 @@ +## Pull Request Checklist + +Before you submit your pull request with a new example, please make sure you have completed the following tasks: + +- [ ] **Update Makefile:** Make sure the new example is included in the following Makefile commands: + - [ ] `install` + - [ ] `build` + - [ ] `test` + - [ ] `clean` + +- [ ] **Update opam file:** Ensure the new example is added to the list of dependencies in the `opam` file. + +- [ ] **Update README:** Add a link to the new example in the README. Provide a brief description if necessary. + +## Description + +Please replace this section to provide a brief description of the example you are creating with this pull request. + +## Additional Notes + +Add any additional information or notes here.