From 767defa9dc7ea7e4bfec0e1ea1a5794c75d89f0a Mon Sep 17 00:00:00 2001 From: mkbreuningIOHK Date: Fri, 8 Mar 2024 16:26:47 +0800 Subject: [PATCH 1/2] docs: update the PR template --- .github/PULL_REQUEST_TEMPLATE.md | 42 +++++++++++--------------------- 1 file changed, 14 insertions(+), 28 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 24cc4ab08..c6fa07cd1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,28 +1,14 @@ -# Overview - - -Fixes # - -## Checklist - -### 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 \ No newline at end of file +### 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/) \ No newline at end of file From 65d69439d24e74ff790e26a36f6e6d53dc390015 Mon Sep 17 00:00:00 2001 From: mkbreuning <97112931+mkbreuningIOHK@users.noreply.github.com> Date: Thu, 14 Mar 2024 18:17:15 +0800 Subject: [PATCH 2/2] Add link to CONTRIBUTING guideline in PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c6fa07cd1..7ef710a99 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,13 @@ ### 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. +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 follows the [contribution guidelines](https://github.com/input-output-hk/atala-prism-apollo/blob/main/CONTRIBUTING.md) 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/) \ No newline at end of file +- [] I have checked the PR title to follow the [conventional commit specification](https://www.conventionalcommits.org/en/v1.0.0/)