From cb645de6794c55001ea74a6c376fad8059890e22 Mon Sep 17 00:00:00 2001 From: ryanycw Date: Thu, 29 Jun 2023 22:54:41 +0800 Subject: [PATCH] chore: add pull request templates --- .github/PULL_REQUEST_TEMPLATE.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 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..a7b881d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,28 @@ +# How to submit a pull request + +This document was modified from [grappafinance/cross-margin-engine](https://github.com/grappafinance/cross-margin-engine). + +## Summary + +Describe the changes made in your pull request here. + +## Details + +Any implementation detail worth pointing out, if any. + +## Todo + +Breakdown the progress of the PR for everyone to see what else you intend to include in this PR. + +- [ ] Draft implementation for `function` +- [ ] Unit tests for `function` + +## Checklist + +Ensure you completed **all of the steps** below before submitting your pull request: + +- [ ] Add [natspec](https://docs.soliditylang.org/en/latest/natspec-format.html) for all functions / parameters +- [ ] Ran `forge snapshot` +- [ ] Ran `forge fmt` +- [ ] Ran `forge test` +- [ ] [Triage Slither issues](../README.md#triage-issues), and post uncertain ones in the PR