Delta Migration Feature

.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
+
+<!-- Check all that apply -->
+
+- [ ] ✨ Feature
+- [ ] 🐛 Bug Fix
+- [ ] 🔥 Hotfix
+- [ ] ♻️ Refactor
+- [ ] 🧹 Chore / Dependency Update
+- [ ] 📝 Documentation
+
+---
+
+## 📝 Description
+
+<!-- A clear and concise summary of what this PR does and why. -->
+
+### What changed?
+
+<!-- Describe the changes in bullet points -->
+
+-
+
+### Why?
+
+<!-- Context, motivation, or problem this solves -->
+
+---
+
+## 🧩 Affected Areas
+
+<!-- Check all modules/layers that are touched -->
+
+- [ ] `api` — Node.js backend
+- [ ] `ui` — React frontend
+- [ ] `upload-api` — Upload API server
+- [ ] `docker` / `docker-compose`
+- [ ] CI / GitHub Actions workflows
+- [ ] Environment variables / config
+- [ ] Other: <!-- specify -->
+
+---
+
+## 🧪 How to Test
+
+<!-- Step-by-step instructions for the reviewer to verify this change -->
+
+1.
+2.
+3.
+
+**Expected result:**
+
+---
+
+## 📸 Screenshots / Recordings
+
+<!-- If UI changes are involved, attach before/after screenshots or a short screen recording -->
+
+| Before | After |
+|--------|-------|
+|        |       |
+
+---
+
+## 🔗 Related PRs / Dependencies
+
+<!-- Link any PRs this depends on or is related to -->
+
+-
+
+---
+
+## ✅ 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
+
+<!-- Anything specific you'd like reviewers to focus on or be cautious about -->
+
+---
+
+> **Migration v2** · [Docs](https://github.com/contentstack/migration-v2#readme) · [Issues](https://github.com/contentstack/migration-v2/issues)

README.md

@@ -19,21 +19,38 @@ Check for readme.md files and install dependencies for folders
 
 This is the migration V2's node server.
 
+### Installation
+
+1. Navigate to the project directory:
+
+   ```sh
+   cd api
+   ```
+
+2. Install the dependencies:
+   ```sh
+   npm install
+   ```
+
 ### Environment Variables
 
 The following environment variables are used in this project:
 
 - `APP_TOKEN_KEY`: The token key for the application. Default is `MIGRATION_V2`.
 - `PORT`: The port number on which the application runs. Default is `5001`.
 
-Make sure to set these variables in a `.env` file at the root of your project.
+Make sure to set these variables in a `.env` file at the root of your api project.
 
 1. To run the development server, create a `./development.env` file and add environment variables as per `./example.env`
 2. To run the production server, create a `./production.env` file and add environment variables as per `./example.env`
 
 ### To start the server
 
-Run `npm run dev`
+Run :
+
+```sh
+`npm run dev`
+```
 
 ## Migration UI
 
@@ -105,7 +122,7 @@ The migration-v2 upload-api project is designed to facilitate the migration of d
 Navigate to the project directory:
 
 ```
-cd migration-v2/upload-api
+cd upload-api
 ```
 
 Install dependencies:
@@ -121,7 +138,7 @@ The following environment variables are used in this project:
 - `PORT`: The port number on which the application runs. Default is `4002`.
 - `NODE_BACKEND_API`: The backend API endpoint. Default is `http://localhost:5001`.
 
-Make sure to set these variables in a `.env` file at the root of your project.
+Make sure to set these variables in a `.env` file at the root of your upload-api project.
 
 ### Configuration
 
@@ -155,6 +172,14 @@ The following configuration is used in this project:
 - `npm run postinstall`: Installs dependencies for the api, ui, and upload-api directories.
 - `npm test`: Displays an error message indicating that no tests are specified.
 
+### Usage
+
+Start the development server:
+
+```sh
+npm start
+```
+
 ## Repository
 
 - Type: git
@@ -202,4 +227,4 @@ The author information is not specified.
 
 ## Contact
 
-For further assistance, please contact the project maintainer through the issues page on GitHub.
+For further assistance, please contact the project maintainer through the issues page on GitHub.