From e46841e2a72ba3c4aafcfb9f03432633bf5607b3 Mon Sep 17 00:00:00 2001 From: mkbreuning <97112931+mkbreuningIOHK@users.noreply.github.com> Date: Fri, 23 Feb 2024 23:18:37 +0800 Subject: [PATCH] docs: update PR template (#896) Signed-off-by: mkbreuningIOHK Signed-off-by: mkbreuning <97112931+mkbreuningIOHK@users.noreply.github.com> Signed-off-by: essbante-io <103904161+essbante-io@users.noreply.github.com> Co-authored-by: Pete Vielhaber Co-authored-by: essbante-io <103904161+essbante-io@users.noreply.github.com> Signed-off-by: Shota Jolbordi --- .github/PULL_REQUEST_TEMPLATE.md | 38 +++++++++++--------------------- 1 file changed, 13 insertions(+), 25 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5932c7dbf9..d20a850019 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,28 +1,16 @@ -# Overview - +### Description: +Summarize the changes you're submitting in a few sentences, including Jira ticket ATL-xxxx if applicable. -Fixes ATL-xxxx +### Context: +It creates traceability on the matter tackled by the PR. It will also help the reviewer understand the PR, linking to related issues, bug reports, or discussions for context. -## Checklist +### Alternatives Considered (optional): +Link to existing ADR (Architecture Decision Record), if any. If relevant, describe other approaches explored and the selected approach. Documenting why the methods were not selected will create a knowledge base for future reference, helping prevent others from revisiting less optimal ideas. -### My PR contains... -* [ ] No code changes (changes to documentation, CI, metadata, etc.) -* [ ] Bug fixes (non-breaking change which fixes an issue) -* [ ] Improvements (misc. changes to existing features) -* [ ] Features (non-breaking change which adds functionality) - -### My changes... -* [ ] are breaking changes -* [ ] are not breaking changes -* [ ] If yes to above: I have updated the documentation accordingly - -### Documentation -* [ ] My changes do not require a change to the project documentation -* [ ] My changes require a change to the project documentation -* [ ] If yes to above: I have updated the documentation accordingly - -### Tests -* [ ] My changes can not or do not need to be tested -* [ ] My changes can and should be tested by unit and/or integration tests -* [ ] If yes to above: I have added tests to cover my changes -* [ ] If yes to above: I have taken care to cover edge cases in my tests +### Checklist: +- [ ] My PR follows the contribution guidelines of this project +- [ ] My PR is free of third-party dependencies that don't comply with the [Allowlist](https://toc.hyperledger.org/governing-documents/allowed-third-party-license-policy.html#approved-licenses-for-allowlist) +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] I have checked the PR title to follow the [conventional commit specification](https://www.conventionalcommits.org/en/v1.0.0/)