From db346b48e89cc316fad6940f7705d4214674e0db Mon Sep 17 00:00:00 2001 From: Fahad Date: Wed, 17 Jan 2024 12:30:47 +0500 Subject: [PATCH] :memo: Pull Request Format Added --- .github/PULL_REQUEST_TEMPLATE.md | 37 ++++++++++++++++++++++++++++++++ 1 file changed, 37 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..beccbe5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,37 @@ +# Pull Request Template + +## Checklist + +- [ ] Branch has been rebased with `master` +- [ ] Commits + - [ ] Have been properly set-up + - [ ] Merge strategy has been specified in the corresponding section +- [ ] Reviewers have been set +- [ ] New or changing code is properly tested + - [ ] TDD has been applied + - [ ] Coverage of at least the happy path has been checked +- [ ] Linters pass +- [ ] Blockers are specified +- [ ] After merging `master` can be deployed +- [ ] Documentation has been added, in godoc and/or README.md + +## Goal + +Why are you doing this. Relevant motivation and context. + +## Merge strategy + +The preferred merge strategy is: + +- [ ] Create a merge commit +- [ ] Squash and merge +- [ ] Rebase and merge + +## Blocked by + +Add links to this project or other projects PRs, issues, reasons and/or people +who's preventing this from beeing merged. + +## How are you doing this + +Ideally this should be empty, the code should be clear and with godoc.