Skip to content

munnavuyyuru/gitflow-project

Repository files navigation

GitFlow Project

Production-grade GitFlow implementation with automated CI, code quality enforcement, and comprehensive documentation.


📖 Table of Contents

  1. Features
  2. Quick Start
  3. Documentation
  4. Workflows
  5. Contributing
  6. License

✨ Features

  • ✅ GitFlow branching strategy implementation
  • ✅ Automated CI with GitHub Actions
  • ✅ Pre-commit hooks for code quality
  • ✅ Semantic versioning
  • ✅ Automated testing pipeline
  • ✅ Security scanning
  • ✅ Comprehensive documentation

📈 GitFlow Diagram

GitFlow Diagram

🚀 Quick Start

# Clone repository
git clone https://github.com/munnavuyyuru/gitflow-project.git
cd gitflow-project

# Install hooks
./scripts/install-hooks.sh

# Install dependencies
npm install

# Run tests
npm test

# Start development server
npm start

📚 Documentation

🌊 Workflows

1. Feature Development

git checkout develop
git checkout -b feature/my-feature

# Make changes
git commit -m "feat: add new feature"
git push origin feature/my-feature

# Create PR to develop

2. Release Process

git checkout develop
git checkout -b release/1.2.0

# Update version and changelog
git push origin release/1.2.0

# PR to main → Tag → Merge back to develop

3. Hotfix

git checkout main
git checkout -b hotfix/1.1.2-critical-fix

# Make fix
git push origin hotfix/1.1.2-critical-fix

# PR to main → Tag → Merge to develop

🤝 Contributing

  1. Read WORKFLOW.md
  2. Create feature branch from develop
  3. Make changes and add tests
  4. Submit PR with filled template
  5. Wait for review and CI checks

📊 Project Stats

  • Branch Protection: Enabled
  • Required Reviews: 1
  • CI : GitHub Actions
  • Test Coverage: ~90%
  • Documentation: Complete

🛠️ Tech Stack

  • Runtime: Node.js
  • CI: GitHub Actions
  • Versioning: Semantic Versioning
  • Strategy: GitFlow

📄 License

MIT License – see LICENSE

Acknowledgments

Built as a production-grade demonstration of GitFlow methodology for DevOps/DevSecOps learning.

About

Production-grade GitFlow implementation

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors