From 6e55f3bb6a6e795638ba1bdd3a2f597bd1381238 Mon Sep 17 00:00:00 2001 From: MaryamAdnan <80243792+MaryamAdnan3@users.noreply.github.com> Date: Fri, 9 Jun 2023 13:31:50 +0500 Subject: [PATCH 1/2] ci: add pr review template closes #21 --- .github/pull_request_template.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 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..d272c8f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,32 @@ +## What +Write a summary of the changes made in the PR. + +## Why +Exlpain the reasons for the changes. + +## Type of change +Select multiple if applicable. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause a breaking change) +- [ ] Tests (adds or updates tests) +- [ ] Documentation (adds or updates documentation) +- [ ] Refactor (style improvements, performance improvements, code refactoring) +- [ ] Revert (reverts a commit) +- [ ] CI/Build (adds or updates a script, change in external dependencies) + +## Dependency Change +If a new dependency is being added, please ensure that it adheres to the following guideline https://github.com/apimatic/apimatic-codegen/wiki/Policy-of-adding-new-dependencies-in-the-core-libraries + +## Breaking change +If the PR is introducing a breaking change, please ensure that it adhares to the following guideline + +## Testing +List the steps that were taken to test the changes + +## Checklist +- [ ] My code follows the coding conventions +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have added new unit tests From 51468f970872b03ebb4cf536be78dba87110ec3f Mon Sep 17 00:00:00 2001 From: Asad Ali Date: Tue, 13 Jun 2023 16:38:36 +0500 Subject: [PATCH 2/2] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d272c8f..c1ca470 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -20,7 +20,7 @@ Select multiple if applicable. If a new dependency is being added, please ensure that it adheres to the following guideline https://github.com/apimatic/apimatic-codegen/wiki/Policy-of-adding-new-dependencies-in-the-core-libraries ## Breaking change -If the PR is introducing a breaking change, please ensure that it adhares to the following guideline +If the PR is introducing a breaking change, please ensure that it adheres to the following guideline https://github.com/apimatic/apimatic-codegen/wiki/Guidelines-for-maintaining-core-libraries ## Testing List the steps that were taken to test the changes