Skip to content

Kanha-OpenSphere/studyFlow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

6 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

how to initialy setup project (after cloning the project)?

  1. install neccecery dependency [npm i] on which side ur working(client or server);
  2. if ur working on server side setup .env file just like sample.env
  3. install an vsCode extention called "restore terminal"(to running script automatically)
  4. after completing above steps just restat vs code or mannualy run scripts to run app

-------------That's it ur good to go now ----------------

rules regarding PRs..

  1. do not make randome changes take a feature build it and make a PR with specific commit messege๐Ÿ˜.

-------------Happy coding--------------------------

๐Ÿš€ Git Workflow Guide

๐Ÿ“Œ Branching Strategy

๐Ÿ”น 1. Main Branches (Long-term)

  • main โ†’ Stable, production-ready code (only merge tested code here).
  • develop โ†’ Main development branch where features are integrated.

๐Ÿ”น 2. Short-Term Branches (Temporary)

  • feature/<feature-name> โ†’ For new features (branched from develop).
  • bugfix/<bug-name> โ†’ For fixing non-critical bugs (branched from develop).
  • hotfix/<hotfix-name> โ†’ For urgent production fixes (branched from main).

๐Ÿ”„ Workflow Steps

๐Ÿ› ๏ธ 1. Start Working on a Feature

git checkout develop
git pull origin develop
git checkout -b feature/new-dashboard

โœ… 2. Work on the Feature & Commit

git add .
git commit -m "Added dashboard UI"
git push origin feature/new-dashboard

๐Ÿ”„ 3. Create a Pull Request (PR) to develop

  • Once reviewed & tested, merge into develop.

๐Ÿž Bug Fix Workflow

๐Ÿ”น 1. Create a Bugfix Branch

git checkout develop
git pull origin develop
git checkout -b bugfix/fix-login-issue

๐Ÿ”น 2. Work on Fix & Push

git add .
git commit -m "Fixed login issue"
git push origin bugfix/fix-login-issue

๐Ÿ”น 3. Merge into develop After Review

  • After testing, merge back into develop.

๐Ÿ”ฅ Hotfix Workflow (For Critical Fixes)

๐Ÿ”น 1. Create Hotfix Branch from main

git checkout main
git pull origin main
git checkout -b hotfix/fix-payment-bug

๐Ÿ”น 2. Apply Fix & Merge

git add .
git commit -m "Fixed payment issue"
git push origin hotfix/fix-payment-bug
  • Merge into main and tag a release
  • Also merge back into develop to keep them in sync

๐Ÿ“Œ Best Practices

โœ… Pull before you start (git pull origin develop) โœ… Use clear branch names (feature/login-page, bugfix/navbar-crash) โœ… Small, frequent commits instead of big ones โœ… Use Pull Requests (PRs) for code review โœ… Tag releases (git tag v1.0.0 && git push origin v1.0.0)


About

someone write it if u want i'm tired๐Ÿ˜ฃ

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published