docs: reorganize implementation plan and expand contributing guidelines #409

Merged

freemo merged 17 commits from chore/removed-imp into master 2026-02-24 03:22:32 +00:00

Conversation 0 Commits 17 Files changed 9 +3542 -9414

freemo commented 2026-02-24 00:30:59 +00:00

Owner

Copy link

Summary

This PR reorganizes the project's documentation by breaking up the monolithic
implementation_plan.md and substantially expanding CONTRIBUTING.md with
process guidelines that were previously missing or buried in the plan.

Changes

• Migrated implementation timeline from implementation_plan.md to docs/timeline.md.
• Migrated implementation notes to docs/implementation-notes.md.
• Relocated remaining content from the implementation plan to the specification and
  CONTRIBUTING.md, then deleted implementation_plan.md from the repository.
• Expanded CONTRIBUTING.md with comprehensive guidance on:
  • Commit scope, quality, and message format (Conventional Changelog).
  • Issue creation process, including required sections (Metadata, Acceptance Criteria,
    Definition of Done).
  • Label system (State/, Priority/, MoSCoW/, Type/, special labels).
  • Ticket lifecycle and state transition rules.
  • Pull Request process, review requirements, and merge checklist.
  • Milestone requirements for issues and PRs.
  • PR labeling rules (Type/ labels on PRs).
  • PR description requirements (detailed body, closing keywords, dependency links).
  • Project-specific conventions (tooling, testing, type checking, code style).
• Updated CHANGELOG.md with entries for all documentation changes.

Motivation

Contributors and automated agents lacked clear, centralized documentation on
how to create issues, write commit messages, submit PRs, and follow the
project's label and lifecycle conventions. The implementation plan contained
useful information but was a monolithic file mixing timelines, notes, and
process guidelines. This PR gives each concern its own home and makes the
contributing guidelines self-contained.

Closes #408

## Summary This PR reorganizes the project's documentation by breaking up the monolithic `implementation_plan.md` and substantially expanding `CONTRIBUTING.md` with process guidelines that were previously missing or buried in the plan. ### Changes - **Migrated implementation timeline** from `implementation_plan.md` to `docs/timeline.md`. - **Migrated implementation notes** to `docs/implementation-notes.md`. - **Relocated remaining content** from the implementation plan to the specification and CONTRIBUTING.md, then **deleted `implementation_plan.md`** from the repository. - **Expanded CONTRIBUTING.md** with comprehensive guidance on: - Commit scope, quality, and message format (Conventional Changelog). - Issue creation process, including required sections (Metadata, Acceptance Criteria, Definition of Done). - Label system (`State/`, `Priority/`, `MoSCoW/`, `Type/`, special labels). - Ticket lifecycle and state transition rules. - Pull Request process, review requirements, and merge checklist. - Milestone requirements for issues and PRs. - PR labeling rules (`Type/` labels on PRs). - PR description requirements (detailed body, closing keywords, dependency links). - Project-specific conventions (tooling, testing, type checking, code style). - **Updated CHANGELOG.md** with entries for all documentation changes. ### Motivation Contributors and automated agents lacked clear, centralized documentation on how to create issues, write commit messages, submit PRs, and follow the project's label and lifecycle conventions. The implementation plan contained useful information but was a monolithic file mixing timelines, notes, and process guidelines. This PR gives each concern its own home and makes the contributing guidelines self-contained. Closes #408

freemo added 9 commits 2026-02-24 00:30:59 +00:00

docs: Updated CONTRIBUTING.md to be inclusive of everything relevant from the implementation plan ... e53c301ab6

Refs: #408

docs: Added commit guidlines to the contributing document ... 9559414dc2

Refs: #408

docs: Moved the implementation timeline out to its own document ... 69b99d49e6

Refs: #408

docs: Moved the notes taken during implementation to its own document ... fb7b20bd6b

Refs: #408

docs: Moved the last elements from implementation plan to their respective locations and deleted the plan from the repo ... 09c2567d60

Refs: #408

docs: Expanded the CONTRIBUTING.md document to give more details to the process of contributing issues, and pull requests ... 96516f4944

Refs: #408

docs: Fixed broken image link in CONTRIBUTING.md ... 9563da6485

Refs: #408

docs: Clarified metadata on CONTRIBUTING.md ... 87d842732b

Refs: #408

docs: update changelog with documentation reorganization entries ... ccff33c7c7

Added an Unreleased section to CHANGELOG.md describing all documentation
changes in this branch: CONTRIBUTING.md expansion, implementation plan
migration to docs/timeline.md and docs/implementation-notes.md, and
removal of the monolithic implementation_plan.md.

Refs: #408

freemo added this to the v3.0.0 milestone 2026-02-24 00:51:40 +00:00

freemo added the

Type

Task

label 2026-02-24 00:51:40 +00:00

freemo added 1 commit 2026-02-24 00:52:01 +00:00

docs: add milestone and PR label requirements to contributing guidelines ... 31094b20b9

Added milestone requirements: issues beyond State/Unverified must be assigned
to a milestone; PRs must be assigned to the same milestone as their linked
issues. Added PR label rules: every PR must carry exactly one Type/ label
matching the nature of the change. Updated the triaging checklist to include
milestone assignment and updated the merge checklist with milestone and label
verification items.

Refs: #408

freemo added a new dependency 2026-02-24 00:58:59 +00:00

#408 chore(docs): reorganize implementation plan and expand contributing guidelines

freemo added 1 commit 2026-02-24 00:59:14 +00:00

docs: add PR description and dependency link requirements to contributing guidelines ... bdda79f24b

Added explicit requirement that every PR must include a detailed description
with a summary, closing keywords for linked issues, and a Forgejo dependency
link. Updated the merge checklist with PR description and dependency link
verification items. Reworked PR Process item 1 to be comprehensive about
both the description body and the issue linkage.

Refs: #408

freemo added 1 commit 2026-02-24 01:03:54 +00:00

docs: require branch/tag ref field on all issues in contributing guidelines ... 0d5e97ff62

Added requirement that every issue must have its Forgejo branch/tag (Ref) field
set to the working branch once work begins. This field is separate from the
branch name in the issue body Metadata section but must match it. Setting the
field allows Forgejo to associate issues with branches in its UI.

Refs: #408

freemo added 1 commit 2026-02-24 01:07:59 +00:00

docs: clarify branch/tag ref rules for development vs non-development issues ... a7c51ed78c

Refined the branch/tag (Ref) field requirement: development issues (features,
fixes, chores) must set it to the same branch as the one in the Metadata
section once the issue reaches State/In Progress, and must always reference a
branch not a tag. Non-development issues (bug reports, questions, support)
may leave it blank or optionally point to the branch or tag being referenced.

Refs: #408

freemo self-assigned this 2026-02-24 01:13:19 +00:00

freemo added 1 commit 2026-02-24 01:15:32 +00:00

docs: add missing reference pages to mkdocs navigation ... d9a492c3ff

Added decision_model, resource_handlers, and resources to the manually-authored
reference page nav entries in gen_ref_pages.py so mkdocs no longer warns about
pages existing in docs/reference/ but not included in the nav.

Refs: #408

freemo force-pushed chore/removed-imp from 625592d4d1 to b1bf2250fb 2026-02-24 01:17:41 +00:00 Compare

freemo added 1 commit 2026-02-24 02:48:14 +00:00

Docs: Removed implementation-notes and migrated that information as comments on tickets 67b4ddf5f8

freemo removed a dependency 2026-02-24 02:55:52 +00:00

#408 chore(docs): reorganize implementation plan and expand contributing guidelines

freemo added a new dependency 2026-02-24 02:57:05 +00:00

#408 chore(docs): reorganize implementation plan and expand contributing guidelines

freemo added 1 commit 2026-02-24 02:58:42 +00:00

Docs: Explicitly indicated dependency direction for blocking characteristics in CONTRIBUTING.md 417d17478f

freemo scheduled this pull request to auto merge when all checks succeed 2026-02-24 02:58:56 +00:00

freemo merged commit 417d17478f into master 2026-02-24 03:22:32 +00:00

freemo deleted branch chore/removed-imp 2026-02-24 03:22:32 +00:00

freemo added the

State

Completed

label 2026-03-04 00:59:09 +00:00

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

auto/needs-reevaluation

Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.

  

controller-managed

Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.

  

auto/blocked-by-deps

PR blocked by an open issue dependency. Operator must close the dep (or remove the dependency link) before the merge driver can act. Auto-cleared by merge_drive when no open deps remain.

  

auto/ci-timeout

Most recent merge cycle hit CI timeout. Driver excludes this PR while last merge_cycle row is < 30 min old; label persists thereafter as visible history.

  

auto/claimed-implementer

Currently being processed by an implementer worker.

  

auto/claimed-merge

Currently being processed by the merge driver.

  

auto/claimed-reviewer

Currently being processed by a reviewer worker.

  

auto/driver-down

Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.

  

auto/invariant-violation

Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.

  

auto/last-attempt-tier-0

In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.

  

auto/last-attempt-tier-1

In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.

  

auto/last-attempt-tier-2

In-cycle escalation: most recent attempt ran at the Tier 2 slot (`tier-2`). Slot's model defined in .opencode/models/tiers.yaml. Gated behind IMPLEMENTER_ESCALATION_TIER2_ENABLED.

  

auto/last-attempt-tier-min

In-cycle escalation: most recent attempt ran at the Tier -1 slot (`tier-min`). Slot's model defined in .opencode/models/tiers.yaml. Suffix is ``-min`` (not ``--1``) so the Forgejo UI reads naturally.

  

Automation Tracking

Tracking issues used by the AI Automation system for agents to communicate and report.

  

auto/needs-conflict-resolution

Rebase conflict needs LLM conflict-resolver.

  

auto/needs-implementer

Failing CI needs implementer attention.

  

auto/postmortem

Documenting a driver incident or rollback.

  

auto/ready-to-merge

Reviewer has APPROVED this PR and no later REQUEST_CHANGES is outstanding. The merge driver requires this label to even consider a PR for merging. Set by the reviewer worker on APPROVE; cleared on REQUEST_CHANGES.

  

auto/restart-throttled

Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.

  

auto/revert

Revert PR backing out an invariant violation. Fast-tracked through the merge driver.

  

auto/sentinel

Sentinel PR duplicated from upstream into a personal fork by tools/duplicate_prs_to_fork.py for pipeline testing. Lives only in the fork; the canonical pipeline never sees it.

  

auto/stale-inactivity

No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.

  

auto/unstable

Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.

  

Blocked

A ticket in a blocked state and unable to complete until some other task is completed first.

  

Bounty

$100

A bounty of $100 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$1000

A bounty of $1000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$10000

A bounty of $10000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$20

A bounty of $20 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$2000

A bounty of $2000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$250

A bounty of $250 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$50

A bounty of $50 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$500

A bounty of $500 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$5000

A bounty of $5000 for any open-source contributor who provides a MR that solves this issue

  

Bounty

$750

A bounty of $750 for any open-source contributor who provides a MR that solves this issue

  

MoSCoW

Could have

Could have feature in order to satisfy the epic/legendary.

  

MoSCoW

Must have

Must have feature in order to satisfy the epic/legendary.

  

MoSCoW

Should have

Should have feature in order to satisfy the epic/legendary.

  

Needs Feedback

There are questions in the ticket that can not be completed until the project owner provides clarity.

  

Points

1

1 man-hours worth of work for an expert with no learning curve.

  

Points

13

13 man-hours worth of work for an expert with no learning curve.

  

Points

2

2 man-hours worth of work for an expert with no learning curve.

  

Points

21

21 man-hours worth of work for an expert with no learning curve.

  

Points

3

3 man-hours worth of work for an expert with no learning curve.

  

Points

34

34 man-hours worth of work for an expert with no learning curve.

  

Points

5

5 man-hours worth of work for an expert with no learning curve.

  

Points

55

55 man-hours worth of work for an expert with no learning curve.

  

Points

8

8 man-hours worth of work for an expert with no learning curve.

  

Points

88

88 man-hours worth of work for an expert with no learning curve.

  

Priority

Backlog

This ticket has backlogged priority and is not to be worked on yet

  

Priority

CI Blocker

Critical priority issue that blocks CI/CD pipeline and prevents PR merges

  

Priority

Critical

The priority is critical

  

Priority

High

The priority is high

  

Priority

Low

The priority is low

  

Priority

Medium

The priority is medium

  

Signed-off: Owner

When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  

Signed-off: Scrum Master

When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  

Signed-off: Tech Lead

When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  

Spike

A ticket for learning a tool or technology that is needed to be able to do future planning and design.

  

State

Completed

The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.

  

State

Duplicate

A ticket that represents the same content as an existing ticket.

  

State

In Progress

A ticket that is actively being developed.

  

State

In Review

A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.

  

State

Paused

This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.

  

State

Unverified

All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.

  

State

Verified

The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.

  

State

Wont Do

This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.

  

Type

Automation

Any edits or discussion about the AI automated coding system.

  

Type

Bug

Something that doesnt work as intended.

  

Type

Discussion

Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.

  

Type

Documentation

An error or improvement needed in the documentation.

  

Type

Epic

Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.

  

Type

Feature

Some new functionality not present.

  

Type

Legendary

A type of Epic which will contain other Epics.

  

Type

Refactor

A code change that restructures existing code without changing its external behavior.

  

Type

Support

Someone needs help using the project.

  

Type

Task

A generic task that doesnt fit into the other type categories.

  

Type

Testing

Work exclusively focusing on fixing or expanding testing.

No labels

auto/needs-reevaluation

controller-managed

auto/blocked-by-deps

auto/ci-timeout

auto/claimed-implementer

auto/claimed-merge

auto/claimed-reviewer

auto/driver-down

auto/invariant-violation

auto/last-attempt-tier-0

auto/last-attempt-tier-1

auto/last-attempt-tier-2

auto/last-attempt-tier-min

Automation Tracking

auto/needs-conflict-resolution

auto/needs-implementer

auto/postmortem

auto/ready-to-merge

auto/restart-throttled

auto/revert

auto/sentinel

auto/stale-inactivity

auto/unstable

Blocked

Bounty

$100

Bounty

$1000

Bounty

$10000

Bounty

$20

Bounty

$2000

Bounty

$250

Bounty

$50

Bounty

$500

Bounty

$5000

Bounty

$750

MoSCoW

Could have

MoSCoW

Must have

MoSCoW

Should have

Needs Feedback

Points

1

Points

13

Points

2

Points

21

Points

3

Points

34

Points

5

Points

55

Points

8

Points

88

Priority

Backlog

Priority

CI Blocker

Priority

Critical

Priority

High

Priority

Low

Priority

Medium

Signed-off: Owner

Signed-off: Scrum Master

Signed-off: Tech Lead

Spike

State

Completed

State

Duplicate

State

In Progress

State

In Review

State

Paused

State

Unverified

State

Verified

State

Wont Do

Type

Automation

Type

Bug

Type

Discussion

Type

Documentation

Type

Epic

Type

Feature

Type

Legendary

Type

Refactor

Type

Support

Type

Task

Type

Testing

Milestone

Clear milestone

No items

No milestone

v3.0.0

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

freemo

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks

#408 chore(docs): reorganize implementation plan and expand contributing guidelines

cleveragents/cleveragents-core

Reference

cleveragents/cleveragents-core!409

No description provided.