Skip to content

docs(guidelines): scope PR ceremony to change size [INBOX-20] #10030

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
saltas888 wants to merge 2 commits into
base: develop
Choose a base branch
from
+37 −0
Draft

docs(guidelines): scope PR ceremony to change size [INBOX-20] #10030

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1b89c4
docs(guidelines): scope PR ceremony to change size [INBOX-20]
saltas888 Jul 23, 2026
d36dfd2
docs(guidelines): exclude str before Sequence narrowing [INBOX-8]
saltas888 Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions dev/guidelines/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ uv run towncrier create -c "Added breadcrumb navigation for hierarchical schemas
uv run towncrier create -c "Updated dependencies to latest versions" +deps-update.housekeeping.md
```

## When to Skip

Skip the fragment entirely when the change has **no user-facing effect** — an internal

@cubic-dev-ai cubic-dev-ai Bot Jul 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P3: This docs-only change targets develop, but per the base-branch rules, changes that can't affect a running product (including docs, tooling, CI) should target stable. Consider retargeting to stable so the guidance ships sooner rather than waiting for the next minor release train.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At dev/guidelines/changelog.md, line 55:

<comment>This docs-only change targets develop, but per the base-branch rules, changes that can't affect a running product (including docs, tooling, CI) should target stable. Consider retargeting to stable so the guidance ships sooner rather than waiting for the next minor release train.</comment>

<file context>
@@ -50,6 +50,14 @@ uv run towncrier create -c "Added breadcrumb navigation for hierarchical schemas
 
+## When to Skip
+
+Skip the fragment entirely when the change has **no user-facing effect** — an internal
+type-annotation correction, a refactor with no behavior change, cleanup of internal docs or
+spec-kit scaffolding. `housekeeping` is for internal changes a user could still plausibly notice
</file context>

type-annotation correction, a refactor with no behavior change, cleanup of internal docs or
spec-kit scaffolding. `housekeeping` is for internal changes a user could still plausibly notice
(a dependency bump, a tooling change) — it is not a catch-all for anything code-adjacent. If it's
unclear whether a change is user-facing, ask rather than defaulting to adding a fragment.

## Writing Good Changelog Messages

- Write from the user's perspective
Expand Down
7 changes: 7 additions & 0 deletions dev/guidelines/git-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,13 @@ Add changelog fragments to `changelog/` using Towncrier. See [Changelog Guidelin
- Any notable implementation details
- Testing performed

**Scope to match the change:** for a trivial, code-only fix with no behavior change (e.g. a
type-annotation correction), ship just the code diff. Don't carry the spec-kit design record
(`dev/specs/<feature>/`, see [Repository Organization](repository-organization.md)) or a
changelog fragment with no user-facing effect (see [When to Skip](changelog.md#when-to-skip))
into the PR — trim them before opening it if the workflow that produced the change generated them
by default.

## Critical Rules

- Never force push to `stable` or `develop`
Expand Down
6 changes: 6 additions & 0 deletions dev/guidelines/repository-organization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ Each directory in `dev/` serves a specific purpose and follows a content lifecyc
- Moved to `knowledge/` (if describing how something works)
- Moved to `guidelines/` (if describing how to use something)

**Proportionality**: Not every change needs a spec. If the actual code change is small enough to
be self-explanatory (e.g. an annotation-only fix, a one-line correction with no behavior change),

@cubic-dev-ai cubic-dev-ai Bot Jul 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P3: The cross-reference link says 'Git Workflow → Pull Requests' but points only to the file root, not the Pull Requests section. Append #pull-requests to the link so the text and target match, consistent with how the git-workflow.md change correctly uses changelog.md#when-to-skip with a section anchor.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At dev/guidelines/repository-organization.md, line 89:

<comment>The cross-reference link says 'Git Workflow → Pull Requests' but points only to the file root, not the Pull Requests section. Append `#pull-requests` to the link so the text and target match, consistent with how the git-workflow.md change correctly uses `changelog.md#when-to-skip` with a section anchor.</comment>

<file context>
@@ -85,6 +85,12 @@ Each directory in `dev/` serves a specific purpose and follows a content lifecyc
 - Moved to `guidelines/` (if describing how to use something)
 
+**Proportionality**: Not every change needs a spec. If the actual code change is small enough to
+be self-explanatory (e.g. an annotation-only fix, a one-line correction with no behavior change),
+skip the spec-kit scaffolding entirely or trim `dev/specs/<feature>/` from the PR before it goes
+to review — the design record should be proportional to the change it documents, not a fixed-cost
</file context>

skip the spec-kit scaffolding entirely or trim `dev/specs/<feature>/` from the PR before it goes
to review — the design record should be proportional to the change it documents, not a fixed-cost
byproduct of running the workflow. See [Git Workflow → Pull Requests](git-workflow.md).

### guidelines/

**Purpose**: "What rules should I follow?"
Expand Down
Loading