From e5f850484ce96b48848a88e6d53f5fc92b23fa44 Mon Sep 17 00:00:00 2001 From: mkbreuning <97112931+mkbreuningIOHK@users.noreply.github.com> Date: Fri, 8 Mar 2024 20:33:12 +0800 Subject: [PATCH] docs: add a PR template (#252) Signed-off-by: mkbreuning <97112931+mkbreuningIOHK@users.noreply.github.com> Signed-off-by: Shailesh Patil --- .github/PULL_REQUEST_TEMPLATE.md | 14 ++++++++++++++ 1 file changed, 14 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 00000000..b206291b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +### Description: +Summarize the changes you're submitting in a few sentences, including Jira ticket ATL-xxxx if applicable. +Link to any discussion, related issues and bug reports to give the context to help the reviewer understand the PR. + +### 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. + +### 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/)