From 5930935fc03bc5aa8c477b6ef60d44d4594c75e5 Mon Sep 17 00:00:00 2001 From: umeshmore45 Date: Thu, 7 May 2026 17:53:12 +0530 Subject: [PATCH] feat: add pull request template for improved contribution guidelines - Introduced a comprehensive PR template to standardize submissions. - Included sections for Jira ticket links, PR type, description, affected areas, testing instructions, and author checklist. - Aims to enhance clarity and consistency in the review process. --- .github/PULL_REQUEST_TEMPLATE.md | 104 +++++++++++++++++++++++++++++++ 1 file changed, 104 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..e30e2843 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,104 @@ +## ๐Ÿ”— Jira Ticket + +> Replace with your ticket link โ€” required before requesting review. + +[MIGRATION-XXXX](https://contentstack.atlassian.net/browse/MIGRATION-XXXX) + +--- + +## ๐Ÿ“‹ PR Type + + + +- [ ] โœจ Feature +- [ ] ๐Ÿ› Bug Fix +- [ ] ๐Ÿ”ฅ Hotfix +- [ ] โ™ป๏ธ Refactor +- [ ] ๐Ÿงน Chore / Dependency Update +- [ ] ๐Ÿ“ Documentation + +--- + +## ๐Ÿ“ Description + + + +### What changed? + + + +- + +### Why? + + + +--- + +## ๐Ÿงฉ Affected Areas + + + +- [ ] `api` โ€” Node.js backend +- [ ] `ui` โ€” React frontend +- [ ] `upload-api` โ€” Upload API server +- [ ] `docker` / `docker-compose` +- [ ] CI / GitHub Actions workflows +- [ ] Environment variables / config +- [ ] Other: + +--- + +## ๐Ÿงช How to Test + + + +1. +2. +3. + +**Expected result:** + +--- + +## ๐Ÿ“ธ Screenshots / Recordings + + + +| Before | After | +|--------|-------| +| | | + +--- + +## ๐Ÿ”— Related PRs / Dependencies + + + +- + +--- + +## โœ… Author Checklist + +> Complete this before moving the PR out of Draft. + +- [ ] Branch follows naming convention: `feature/`, `bugfix/`, or `hotfix/` + 5โ€“30 lowercase chars +- [ ] Jira ticket linked above +- [ ] Self-reviewed the diff โ€” no debug logs, commented-out code, or TODOs left in +- [ ] `.env` / `example.env` updated if new environment variables were added +- [ ] No sensitive credentials or secrets committed +- [ ] Existing tests pass locally (`npm test`) +- [ ] New tests written (or not applicable โ€” explain why) +- [ ] `README.md` / docs updated if behaviour changed +- [ ] Talisman pre-push scan passes (no secrets flagged) + +--- + +## ๐Ÿ‘€ Reviewer Notes + + + +--- + +> **Migration v2** ยท [Docs](https://github.com/contentstack/migration-v2#readme) ยท [Issues](https://github.com/contentstack/migration-v2/issues)