Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add pull request template #181

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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:**