Skip to content

GIT_WORKFLOW.md

Latest commit

 

History

History
47 lines (33 loc) · 1.38 KB

GIT_WORKFLOW.md

File metadata and controls

47 lines (33 loc) · 1.38 KB

Git Workflow

This document outlines the conventions for using Git and writing commit messages in this project.

Commit Message Format

All commit messages should follow this format:

<type>: <subject>

<body (optional)>

Types:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, etc.)
  • config: Changes to configuration files
  • chore: Changes to the build process or auxiliary tools and libraries

Examples:

feat: Add dark mode toggle button to header
fix: Correct baseurl in project site configuration
docs: Update INSTALL.md with Docker troubleshooting
style: Format all Liquid templates with Prettier
config: Enable blog section in _config.yml
chore: Update Jekyll dependencies with bundle update --all

Staging Changes

Always git add files explicitly. Do not stage everything with git add . unless you are certain of what's being committed. Check git status first to review your changes.

What NOT to Commit

Always obey the project's .gitignore file. It prevents the accidental commit of:

  • Build outputs (_site/, .jekyll-cache/)
  • Dependencies (node_modules/, vendor/)
  • OS-specific files (.DS_store)
  • Editor temporary files (.idea/, .swp, .swo)
  • Secrets and API keys (never commit credentials)