RGVPCore v5.2

VS Code & Git Working Procedure

Your Guide to Efficient Development Workflow at RG-VP Web Solutions

Clone a Git Repository in VS Code

🧭 Pre-Requisites

  • Ensure Git is installed (git --version)
  • Install Visual Studio Code
  • Login to your GitHub account in VS Code

Step-by-Step β€” Clone Using Graphical Interface

  1. Open VS Code β€” launch and locate the Explorer panel (two-sheet icon πŸ“).
  2. Open the Source Control View β€” click the icon on the left sidebar.
  3. Click β€œClone Repository” β€” select it when prompted.
  4. Enter Repository URL:
    Example: https://github.com/rpvivek/domain-name.git
    You may also type rpvivek/ to see repository suggestions.
  5. Select Destination Folder:
    Choose: /mnt/RGVPData/www/
    VS Code creates a subfolder (e.g., domain-name).
  6. Wait for Clone to Complete β€” progress appears at the bottom-right corner.
  7. Click β€œOpen Repository” once prompted.

Working with VS Code Projects

πŸ–₯️ Step 1: Open the Project

  1. Go to File β†’ Open Folder
  2. Navigate to /mnt/RGVPData/www/
  3. Select your project folder (e.g., example.com)
  4. Wait for files to load in the Explorer sidebar

πŸ”„ Step 2: Perform Git Pull Before Starting Work

Purpose: Always sync your local code before editing.

  1. Click the Source Control icon
  2. Click the β€œβ€¦β€ menu β†’ select Pull
  3. Or use Terminal: git pull
Log your task in CRM and track it in JIRA before starting.

πŸ’Ύ Step 3: Check for Updated Server Files

  • Compare timestamps with the live server files
  • If newer on the server, download via SFTP or FileZilla
  • Work only on the latest version

✏️ Step 4: Make Necessary Code Changes

  • Open the required file
  • Apply your edits and save (Ctrl + S)
  • Upload to the test environment of the live server
  • Verify your changes before proceeding

πŸš€ Step 5: Git Pull Again Before Push

  • Run git pull to fetch updates
  • Commit and push:
    git add .
    git commit -m "JIRA#123: Fixed homepage banner issue"
    git push
Notify all developers after a successful push to perform git pull. Avoid conflicts by always syncing first.

βœ… Step 6: Update CRM and JIRA Tasks

  • Mark task complete in crm.rgvp.in
  • Link your JIRA Task ID and commit message
  • Example: JIRA#145 - Updated validation in registration form

🧭 Summary Workflow

Step Action Tool Remarks
1 Open Project VS Code /mnt/RGVPData/www/{domain-name}
2 Git Pull VS Code / Terminal Always before starting
3 Update Files Server Get latest version
4 Modify & Test VS Code + Test Server Validate
5 Pull β†’ Commit β†’ Push Git Sync safely
6 Update CRM & JIRA CRM / JIRA Close tasks

🧠 Developer Discipline Guidelines

  • πŸ” Always pull before push
  • 🧩 Keep commits clean and linked with JIRA/CRM IDs
  • πŸ§ͺ Test thoroughly before deployment
  • πŸ• Communicate frequently with your team
  • 🚫 Avoid overwriting or force-pushing branches

Git Commit Message Examples

Follow the standard commit structure for clarity and task tracking:

Format:
[TASK_TYPE] {TaskName} - {Brief Description} | {UserName} | {TaskID}

🧱 Website Update / General Changes

[UPDATE] Homepage SEO Optimization - Added Meta Tags and OG Data | Vivek | JIRA#145
[UPDATE] Contact Page - Integrated new form validation script | Rohit | CRM#2031

✏️ Inserting or Editing Content

[CONTENT] About Us Section - Updated Company Vision Paragraph | Vivek | JIRA#121
[CONTENT] Services Page - Added new Cleaning Packages Description | Priya | CRM#2284

🎨 Layout or UI Changes

[LAYOUT] Homepage Banner - Adjusted alignment and spacing for mobile | Vivek | JIRA#155
[LAYOUT] Footer Section - Modified icons and links layout | Anjali | CRM#1955

🐞 Bug Fixes

[FIX] Login Functionality - Resolved redirect loop issue | Vivek | JIRA#172
[FIX] Contact Form - Fixed email sending issue | Akshay | CRM#2009

🧩 Feature Add-on / New Functionality

[ADD] User Dashboard - Added dark mode toggle feature | Vivek | JIRA#198
[ADD] Blog Module - Implemented comment moderation system | Priya | CRM#2120

πŸ—οΈ Creating New Page / Component

[CREATE] Gallery Page - Added responsive image grid and captions | Vivek | JIRA#203
[CREATE] Testimonials Component - Built reusable slider | Anjali | CRM#2107

πŸ”§ Layout or Design Fixes

[LAYOUT FIX] Navbar - Adjusted dropdown hover delay and padding | Vivek | JIRA#230
[LAYOUT FIX] Mobile View - Fixed overlapping buttons | Rohit | CRM#2118

πŸ—‘οΈ Code / Feature Removal

[REMOVE] Deprecated API Calls - Cleaned unused endpoints | Vivek | JIRA#175
[REMOVE] Old Banner Slider - Removed outdated script and assets | Akshay | CRM#2075

πŸ“˜ Summary Format Reference

[UPDATE] {TaskName} - {Short Description} | {UserName} | {JIRA# or CRM#}
[CONTENT] {PageName} - {Edited Section} | {UserName} | {TaskID}
[FIX] {ModuleName} - {Bug Description} | {UserName} | {TaskID}
[LAYOUT] {ComponentName} - {Design Adjustment} | {UserName} | {TaskID}
[LAYOUT FIX] {ElementName} - {Resolved UI Issue} | {UserName} | {TaskID}
[ADD] {FeatureName} - {What Was Added} | {UserName} | {TaskID}
[CREATE] {Page/ComponentName} - {Created Functionality} | {UserName} | {TaskID}
[REMOVE] {Feature/CodeName} - {Removed Item Details} | {UserName} | {TaskID}

Powered by RG-VP WEB SOLUTIONS