Skip to content

Commit 168720d

Browse files
authored
docs(contexts): prevent hard-wrapped GitHub prose (#113)
## Summary Add a canonical source-format contract for GitHub Issue, Pull Request, Discussion, and comment bodies so future contributors and agents do not hard-wrap remote prose at 80 columns. Route the contract through `AGENTS.md`, `CLAUDE.md`, both `quantmind-dev` skill copies, the pull-request workflow, the development-context index, label guidance, and the Issue/PR templates. Add regression coverage for every route, template marker, and mirrored skill reference. The root cause was generation-side prose wrapping, not Ruff or another repository lint rule. This keeps Python's 80-column configuration and repository Markdown formatting unchanged while applying no-wrap normalization only to GitHub bodies. ## Related Issue No issue applies; this is a focused contributor-governance fix requested during Issue maintenance. ## Verification - `python -m pytest --no-cov -q tests/test_contexts.py` — 6 passed, 50 subtests passed. - `bash scripts/verify.sh` — Ruff, BasedPyright, 5 import contracts, and 292 tests passed; total coverage 88.55%. - Commit and pre-push hooks passed without bypassing verification. ## Checklist - [x] The title uses English Conventional Commit format: `type(scope): summary`. - [x] The related issue or design discussion is linked when applicable. - [x] `bash scripts/verify.sh` passes. - [x] Every applicable live-network component smoke test passes, or this PR states why none applies. - [x] Public behavior has focused tests, an example, and documentation where applicable. - [x] The PR is complete, small, and contains no unrelated changes. No live-network component or runtime public behavior changes; live smoke tests and a usage example are not applicable.
1 parent b761d81 commit 168720d

13 files changed

Lines changed: 145 additions & 7 deletions

File tree

.agents/skills/quantmind-dev/SKILL.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@ Development workflow for contributing to the QuantMind codebase.
1717
operation or public-network source.
1818
4. When creating, updating, or triaging an issue or pull request, use the
1919
canonical [repository label guidance](../../../contexts/dev/labels.md).
20-
5. Pick exactly one workflow reference below; do not load the others.
20+
5. Before writing or editing any GitHub body, follow the canonical
21+
[GitHub writing style](../../../contexts/dev/github-writing.md), including
22+
its no-hard-wrap rule.
23+
6. Pick exactly one workflow reference below; do not load the others.
2124

2225
## Select Workflow
2326

.agents/skills/quantmind-dev/references/pull-request.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@ batch input`, `docs(readme): update quick start`.
3434

3535
Written in English (external audiences read it: contributors, search
3636
indexers, future maintainers). Follow `.github/PULL_REQUEST_TEMPLATE.md`
37-
and make sure the body covers:
37+
and the canonical
38+
[GitHub writing style](../../../../contexts/dev/github-writing.md). Do not
39+
hard-wrap body prose at 80 columns or another fixed width. Make sure the body
40+
covers:
3841

3942
1. **What changed and why** — a short summary; link the design discussion
4043
if one exists.

.claude/skills/quantmind-dev/SKILL.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@ Development workflow for contributing to the QuantMind codebase.
1717
operation or public-network source.
1818
4. When creating, updating, or triaging an issue or pull request, use the
1919
canonical [repository label guidance](../../../contexts/dev/labels.md).
20-
5. Pick exactly one workflow reference below; do not load the others.
20+
5. Before writing or editing any GitHub body, follow the canonical
21+
[GitHub writing style](../../../contexts/dev/github-writing.md), including
22+
its no-hard-wrap rule.
23+
6. Pick exactly one workflow reference below; do not load the others.
2124

2225
## Select Workflow
2326

.claude/skills/quantmind-dev/references/pull-request.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@ batch input`, `docs(readme): update quick start`.
3434

3535
Written in English (external audiences read it: contributors, search
3636
indexers, future maintainers). Follow `.github/PULL_REQUEST_TEMPLATE.md`
37-
and make sure the body covers:
37+
and the canonical
38+
[GitHub writing style](../../../../contexts/dev/github-writing.md). Do not
39+
hard-wrap body prose at 80 columns or another fixed width. Make sure the body
40+
covers:
3841

3942
1. **What changed and why** — a short summary; link the design discussion
4043
if one exists.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ labels: ['type: bug']
66
assignees: ''
77
---
88

9+
<!-- github-prose-style: Keep each logical paragraph/list item on one physical line; do not hard-wrap at 80 columns. -->
10+
911
## 🐛 Bug Description
1012

1113
<!-- A clear and concise description of what the bug is. -->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ labels: ['type: feature']
66
assignees: ''
77
---
88

9+
<!-- github-prose-style: Keep each logical paragraph/list item on one physical line; do not hard-wrap at 80 columns. -->
10+
911
## ✨ Feature Summary
1012

1113
<!-- A clear and concise description of the feature you'd like to see implemented. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- github-prose-style: Keep each logical paragraph/list item on one physical line; do not hard-wrap at 80 columns. -->
2+
13
## Summary
24

35
<!-- What changed and why? Keep this concise and link the design when useful. -->

AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ A new feature ships with a unit test **and** a focused example:
8989

9090
- Commit messages: English, Conventional Commits.
9191
- PR titles, PR bodies, and issue bodies: English.
92+
- GitHub Issue, Pull Request, Discussion, and comment body formatting follows
93+
the [GitHub writing style](contexts/dev/github-writing.md); never hard-wrap
94+
remote prose at 80 columns or another fixed width.
9295
- Code comments and docstrings: English, Google style.
9396

9497
## Development Workflows

CLAUDE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ A new feature ships with a unit test **and** a focused example:
9090

9191
- Commit messages: English, Conventional Commits.
9292
- PR titles, PR bodies, and issue bodies: English.
93+
- GitHub Issue, Pull Request, Discussion, and comment body formatting follows
94+
the [GitHub writing style](contexts/dev/github-writing.md); never hard-wrap
95+
remote prose at 80 columns or another fixed width.
9396
- Code comments and docstrings: English, Google style.
9497

9598
## Development Workflows

contexts/dev/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ canonical source instead of treating this page as a replacement for it.
88
| Architecture constraints and module ownership | [`AGENTS.md`](../../AGENTS.md) or [`CLAUDE.md`](../../CLAUDE.md) |
99
| Component-development workflow | [`quantmind-dev` component workflow](../../.agents/skills/quantmind-dev/references/develop-components.md) |
1010
| Issue and pull-request labels | [Repository label guidance](labels.md) |
11+
| Issue and pull-request body formatting | [GitHub writing style](github-writing.md) |
1112
| Public operation and source catalog | [`docs/README.md`](../../docs/README.md) |
1213
| Public operation naming | [Operation naming contract](../../docs/design/en/operations.md) |
1314
| Component designs | [`docs/design/`](../../docs/design/) |

0 commit comments

Comments
 (0)