Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1 KB

git.instructions.md

File metadata and controls

43 lines (30 loc) · 1 KB

GitHub Copilot Instructions

Git Commit Guidelines

Commit Message Format

  • Use imperative mood in commit messages (e.g., "Add feature" not "Added feature")
  • Start with a verb: Add, Update, Fix, Remove, Refactor, etc.
  • Keep the summary line under 50 characters
  • Use present tense

Commit Message Structure

<type>: <short summary>

<detailed description (optional)>

Types

  • feat: New feature or content
  • fix: Bug fix or correction
  • docs: Documentation changes
  • style: Formatting, CSS changes (no code change)
  • refactor: Code refactoring
  • chore: Maintenance tasks

Examples

Good commit messages:

  • feat: Add atomic habits book review post
  • fix: Correct typo in classification metrics post
  • style: Update post layout spacing
  • docs: Update README with setup instructions

Description Guidelines

  • Explain WHAT changed and WHY (not HOW)
  • Use bullet points for multiple changes
  • Reference issue numbers if applicable
  • Keep it concise but informative