Skip to content

📚 Expand README with integrations and troubleshooting guide#1

Open
mj-muin wants to merge 1 commit intomainfrom
docs/integration-and-troubleshooting
Open

📚 Expand README with integrations and troubleshooting guide#1
mj-muin wants to merge 1 commit intomainfrom
docs/integration-and-troubleshooting

Conversation

@mj-muin
Copy link

@mj-muin mj-muin commented Feb 8, 2026

Overview

Adds comprehensive integration examples and troubleshooting guide to help developers integrate git-why into their workflows and resolve common issues.

Changes

  • IDE Integration: VS Code, JetBrains IDEs
  • CI/CD Integration: GitHub Actions, pre-commit hooks
  • Shell Integration: Functions, git aliases
  • Collaboration Tools: Slack/Discord bot integration
  • Build Tools: npm scripts examples
  • Troubleshooting: 12+ common issues with solutions
  • Documentation Generation: CI/CD automation
  • Monorepo Workflows: Enhanced examples

Statistics

  • Lines added: 669
  • New sections: Integrations, Troubleshooting
  • Integration examples: 8 different environments
  • Troubleshooting items: 12+

Links to new sections

Why this matters

  • Makes git-why easier to integrate into existing workflows
  • Reduces friction for new users
  • Provides ready-to-use automation examples
  • Helps users solve common problems without opening issues

- Add VS Code, JetBrains IDE integration
- Add GitHub Actions, pre-commit hooks
- Add shell functions, git aliases
- Add Slack/Discord bot integration
- Add npm scripts examples
- Add comprehensive troubleshooting section (12+ issues)
- Add CI/CD documentation generation
- Improve monorepo workflow examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant