Skip to content

chore: improve AGENTS.md with development workflow documentation #128

@andreafspeziale

Description

@andreafspeziale

Context

The current AGENTS.md contains a section on conventional commits but lacks a broader description of the development workflow. It should be improved to document the full development process.

What to do

Replace/expand the conventional commit section in AGENTS.md with a more comprehensive development workflow guide covering:

Two development modes

  1. Direct development on develop (default branch)

    • When to use: small changes, chores, quick fixes
    • Workflow: commit directly on develop, push, CI runs, merge to main when ready
  2. Feature branch from issue

    • When to use: work tracked as a GitHub issue
    • Branch naming convention (TBD — e.g. feat/123-short-description, fix/123-short-description)
    • Workflow: create branch from develop, implement, PR back to develop
    • How the branch relates to the issue (linking, closing keywords)

Topics to reflect on and define

  • Branch naming convention for feature branches
  • PR merge strategy (squash? merge commit? rebase?)
  • How conventional commits map to the release pipeline (release-it + conventional changelog)
  • Whether develop -> main merge has specific rules or cadence

This is a planning/reflection item — the exact workflow details need to be decided before documenting.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions