Skip to content

Add contextual help and examples via tooltips #14

@ErnestoIngles

Description

@ErnestoIngles

Description

Many users (especially juniors) might not be familiar with what content should go into the Body or Footer sections of a Conventional Commit. This issue aims to add an educational layer to the tool by providing contextual help icons.

Proposed Features

  • Add info icons (? or i) next to section labels.
  • Implement tooltips or small popovers that explain the purpose of each field.
  • Provide a "Professional Example" inside each tooltip to guide the user.

User Stories

  • As a user, I want to see an example of a good commit body so I can improve my documentation.
  • As a user, I want to know what "Breaking Changes" are when I'm filling out the Footer.

Acceptance Criteria

  • Tooltips are visible on hover or click.
  • Content is clear and provides real-world commit examples.
  • The help system does not clutter the main UI.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions