Docs
Read the setup guides
Start with installation, provider setup, review workflows, commit messages, and terminal behavior.
Public Support Hub
Technical docs and issue reporting for Commit Guard.
This site is the public home for Commit Guard documentation, setup guidance, commit-message behavior, terminal workflow details, and the GitHub issue tracker used for bugs and feature requests.
- Use the docs when you need setup, troubleshooting, or feature guidance
- Use the issue tracker for reproducible bugs and product requests
Where to start
Fast links for users, reviewers, and internal teams.
Issues
Report or request
File public bugs, regressions, and feature requests through the support repository issue tracker.
Documentation
Documentation that matches how the plugin actually works.
The docs focus on the public behaviors users need to understand: setup, providers, review workflows, Platinum commit-message generation, terminal commit hooks, and troubleshooting paths.
Onboarding
Getting Started
Install the plugin, configure providers, run the first review, and understand the main setup paths.
Reference
Technical Information
See supported provider types, plans, workflow capabilities, compatibility details, and operational notes.
Workflow
Commit Messages
Understand IntelliJ generation, terminal prefills, Jira ticket handling, templates, and Platinum scope.
FAQ
Common questions
Find quick answers about providers, editions, commit hooks, issue reporting, and expected product behavior.
Public Support
Use the issue tracker for product feedback and reproducible problems.
The support repo is public so users, JetBrains reviewers, and your team all have one clear place to discuss bugs and requests.
Report a bug
Use the bug report template when something is broken, regressed, or behaving inconsistently.
- Include IntelliJ version and plugin version
- Include provider, edition, and reproduction steps
- Attach logs or screenshots when possible
Request a feature
Use the feature request template when you want a new capability, workflow, or UX improvement.
- Describe the workflow you are trying to enable
- Explain what blocks you today
- Note any alternatives you already tried
Before filing publicly
Check the docs first, then use the public issue tracker for product bugs, regressions, and enhancement requests.
- Check the docs first for setup and expected behavior
- Use the public issue tracker for product bugs and enhancements
- Include reproduction steps, plugin version, and screenshots when possible
Need the main product site instead?
The main public website still hosts product overview, legal pages, and Marketplace-facing content. This support site stays focused on docs and public support workflows.