From 40cb7fb41a08e2f0aea8cf32dfdaab1fb47a710c Mon Sep 17 00:00:00 2001 From: Catalina Oyaneder Date: Tue, 21 Nov 2023 17:06:27 +0000 Subject: [PATCH] chore: add pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 47 ++++++++++++++++++++++++++++++++ 1 file changed, 47 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..3c650de4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,47 @@ +## PR Checklist - Instructions + +Before submitting, ensure your PR meets the following requirements: + +- **Compliance:** + - Includes a detailed description of the changes. + - Assess and state the risk (Low | Medium | High) regarding existing functionality. + +- **Documentation:** + - Links to automated tests covering the new functionality. + - Provides manual testing instructions. + - Includes a GitBook documentation PR link, if applicable. + +- **Commit Guidelines:** + - The commit message is descriptive and uses `feat:` or `fix:` prefix when needed. + - Reference: https://www.conventionalcommits.org/en/v1.0.0/ guidelines. + +- **Testing:** + - Ensures changes are covered by tests (acceptance/integration/smoke). + +## Review Process + +- PRs require thorough reviews, including code, documentation, and testing. +- Manual testing is the submitter's responsibility. +- For Node projects, ensure `package.json` updates align with `package-lock.json`. +- Minimize dependencies; justify new ones. + +## PR Approval + +- Post-review, PRs are approved by code owners and merged by them or content writers for documentation. + +## Submission Fields + +- **What does this PR do?** + +- **Where should the reviewer start?** + +- **How should this be manually tested?** + +- **Any background context?** + +- **Relevant tickets?** + +- **Screenshots (if applicable):** + +- **Additional questions or comments:** +