Skip to content

doc: Create documentation for Conventional Commits #9

@p-iknow

Description

@p-iknow

Requirement

Create comprehensive documentation for Conventional Commits that serves as the source of truth for our commit conventions.

Goals

  • Make it crystal clear: what commit formats we use in the OSS project, why we chose these formats, example use cases, and how they map to our issue templates
  • This should be the source of truth that our commitlint config is based on
  • Call out any limitations or gaps in the current commit conventions where we might need to iterate
  • Check the custom commands under the commands folder to see what they're used for and what commit conventions they follow

Doc Structure

  • Overview

    • What we're trying to accomplish with Conventional Commits
    • Link to the official Conventional Commits spec
  • Breakdown of each commit type

    • Show how to use scopes with ()
  • Real-world scenarios with matching commit examples

    • Make it dead simple for devs to pick the right prefix for their commits

Implementation Plan

Documentation type: Technical documentation / Developer guide

Content outline:

  1. Overview and rationale for Conventional Commits
  2. Commit type reference (feat, fix, doc, config, refactor, agent, test, perf)
  3. Scope usage guidelines and examples
  4. Mapping to issue templates
  5. Real-world scenarios with examples
  6. Current limitations and future improvements

Files to be modified:

  • Create new documentation file (e.g., docs/CONVENTIONAL_COMMITS.md or CONTRIBUTING.md)
  • Update relevant references in other documentation

Should be tested

  • Documentation reviewed for accuracy
  • Examples tested and working
  • Consistency with existing documentation maintained
  • References and links properly connected
  • All commit types match our issue templates
  • Custom commands reviewed for commit convention alignment

Reference

Metadata

Metadata

Assignees

Labels

docDocumentation changes

Type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions