From 954e5656329ee0cb1bdec19af5b96db7af40515d Mon Sep 17 00:00:00 2001 From: Shreyansh Jain Date: Thu, 13 Feb 2025 20:29:05 +0530 Subject: [PATCH 1/2] chore: add merge request template --- .../pull_request_template_api.md | 63 +++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md new file mode 100644 index 0000000..dea1d35 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md @@ -0,0 +1,63 @@ +## API PR Checklist + +### Pre-requisites + +- [ ] I have gone through the Contributing guidelines for [Submitting a Pull Request (PR)](https://github.com/OsmosysSoftware/dotnet-foundation/blob/main/CONTRIBUTING.md#submitting-a-pull-request-pr) and ensured that this is not a duplicate PR. +- [ ] I have performed unit testing for the new feature added or updated to ensure the new features added are working as expected. +- [ ] I have performed preliminary testing to ensure that any existing features are not impacted and any new features are working as expected as a whole. +- [ ] I have added/updated the `.env.example` file with the required values as applicable. + +### PR Details + +PR details have been updated as per the given format (see below) + +- [ ] PR title adheres to the format specified in guidelines (e.g., `feat: add admin login endpoint`) +- [ ] Description has been added +- [ ] Related changes have been added (optional) +- [ ] Screenshots have been added (optional) +- [ ] Query request and response examples have been added (as applicable, in case added or updated) +- [ ] Documentation changes have been listed (as applicable) +- [ ] Unit testing output is added (as applicable) +- [ ] Pending actions have been added (optional) +- [ ] Any other additional notes have been added (optional) + +### Additional Information + +- [ ] Appropriate label(s) have been added +- [ ] Assignee(s) and reviewer(s) have been added (optional) + +_Note: Reviewer should ensure that the checklist and description have been populated and followed correctly, and the PR should be merged only after resolving all conversations and verifying that CI checks pass._ + +--- + +**Description:** + +Add brief description about the changes made in this PR and their purpose. This section can also include mention to any other PRs or issues if needed. + +**Related changes:** + +- Add short points about the different changes made within the files in this PR. + +**Screenshots:** + +Add any screenshots as required. + +**Query request and response:** + +- Add any query request body, cURL statement and response body for the made change or addition. + +**Documentation changes:** + +- Add a list of changes made to the API documents with brief descriptions. + +**Unit testing output:** + +- Add the output of the status of different test cases in the unit testing performed. + +**Pending actions:** + +- Add list of any pending actions that have or would require to be done in this PR. + +**Additional notes:** + +- Add list of any additional notes you may want to convey in this PR. From 57a4c1f309fba91cefcd5074307a30fe35596378 Mon Sep 17 00:00:00 2001 From: Shreyansh Jain Date: Thu, 13 Feb 2025 20:49:00 +0530 Subject: [PATCH 2/2] chore: update merge template comment --- .github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md index dea1d35..8ee0a81 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md @@ -23,7 +23,7 @@ PR details have been updated as per the given format (see below) ### Additional Information -- [ ] Appropriate label(s) have been added +- [ ] Appropriate label(s) have been added (`ready for review` should be added if the PR is ready to be reviewed) - [ ] Assignee(s) and reviewer(s) have been added (optional) _Note: Reviewer should ensure that the checklist and description have been populated and followed correctly, and the PR should be merged only after resolving all conversations and verifying that CI checks pass._