Skip to content

Single-page Conventional Commits generator to craft Git commit messages with type/scope, subject, body, BREAKING CHANGE, API Endpoint, Issue/Defect ID, Task/Assigned By, and one-click copy.

License

Notifications You must be signed in to change notification settings

one-numan/commit-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

commit-generator

A single‑page Conventional Commits builder to generate clean, consistent Git commit messages in seconds.

Features

  • Conventional Commits header: type, optional scope, concise imperative subject.
  • Optional body with “what” and “why,” plus structured footers.
  • Built‑in footers: BREAKING CHANGE, API‑Endpoint, Issue‑Id/Defect‑Id, Task‑Id, Assigned‑By.
  • Live preview, one‑click copy to clipboard, download as .txt, and git commit command preview.
  • Credits modal and in‑file attribution comment for transparent crediting.

Demo

  • Open the single file and use the form to compose and preview a complete commit message.
  • Copy to clipboard or download as a text file; optionally copy the suggested git commit command.

Quick start

  • Clone or download this repository.
  • Open index.html in any modern browser (no build tools or servers required).
  • Fill type/scope, subject, and optional body/footers; then copy or download the generated message.

Usage guide

  • Header: type(optional scope): subject
  • Body (optional): explain the intent and rationale briefly.
  • Footers (optional):
    • BREAKING CHANGE:
    • API-Endpoint:
    • Issue-Id or Defect-Id:
    • Task-Id:
    • Assigned-By:

Example commit messages

  • feat(ui): add single‑page commit generator with preview and copy
  • fix(copy): handle clipboard failures with graceful fallback alert
  • docs(readme): add usage guide and examples

Project structure

  • index.html — self‑contained HTML/CSS/JS app with UI, preview, copy/download, and credits modal.

Tech stack

  • HTML, CSS, and vanilla JavaScript (no dependencies).

Accessibility

  • Keyboard: modal supports Escape to close; large click targets and clear contrast.
  • Content: concise labels, hints, and predictable field order.

Browser support

  • Designed for modern browsers; clipboard copy uses the standard Clipboard API and gracefully falls back to manual copy if unavailable.

Security notes

  • External links (e.g., GitHub credit) open in a new tab and use safe target and rel attributes.
  • No network requests or tracking; runs entirely client‑side.

Why this exists

  • Enforces consistent, scannable history for easier reviews, rollbacks, and automated changelogs.
  • Speeds up daily workflow by removing friction in writing Conventional Commits.

Roadmap

  • Optional 50/72 helper and soft line wrap indicator.
  • Local autosave of last message fields.
  • Export/import presets for common scopes and footers.
  • i18n for labels and hints.

Contributing

  • Fork, create a feature branch, and submit a pull request with a focused change and clear commit messages.
  • Keep UI minimal, accessible, and dependency‑free.

Credits

  • Code credits: One‑numan.
  • Conventional Commits inspiration and structure.

License

  • MIT License.

About

Single-page Conventional Commits generator to craft Git commit messages with type/scope, subject, body, BREAKING CHANGE, API Endpoint, Issue/Defect ID, Task/Assigned By, and one-click copy.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages