[nicolasdmolina]

User problem

Commit and pull-request titles in this repository already use NumPy-style prefixes (FIX:, DOC:, MAINT:, …), but the list was never written down. Synonyms have drifted (FIX:/BUG:, DOC:/DOCS:, TST:/TEST:, MAINT:/IMP:/INFR:), so a contributor has no way to pick correctly.

Scope

Document the canonical prefix list in the contributing guide:

• one-line definition per prefix
• synonyms named as deprecated
• mapping to QEP-2 Type labels where one exists

CONTRIBUTING.md now points at that section. This does not add a pull-request template; that file is not in-tree and is tracked as #892. When #892 lands, the template should reference this convention.

Design choice

RFC: stays the refactor prefix (it is already in use) rather than introducing a new REF: synonym. CI: is listed as canonical because it is the most common prefix on main and maps to the same QEP-2 Type as INFR: (infrastructure), with a narrower one-line definition (workflow files vs broader tooling).

Closes #902

[quantecon-services]

Hi @nicolasdmolina — a quick process note while this is in the review queue.

QuantEcon's Code of AI Use (QEP-5, QuantEcon/qeps#13) doesn't restrict AI-assisted contributions, but it does ask that meaningful AI involvement be disclosed. We'd like it in two places: a trailer in the commit message, and a one-line note in the PR description.

If AI tools were involved here, please add the trailer:

Assisted-by: <tool name>

(git commit --amend, then force-push the branch.) And add a line to the PR description saying which tools were used and for what. If the work was entirely hand-written, a quick note here saying so is equally useful.

The intent is that reviewers know what to expect, and that a human has chosen the task, checked the result, and will own the follow-up discussion.

---

Generated by Claude Code

[nicolasdmolina]

AI Usage Disclosure: This contribution was hand-written; no AI tools were used in authoring the commit or PR description. Added per QuantEcon's Code of AI Use (QEP-5).

[coveralls]

coverage: 93.967%. remained the same — nicolasdmolina:doc/commit-prefix-convention-902 into QuantEcon:main

[mmcky]

thanks for your PR @nicolasdmolina -- appreciated. I will review this PR in the next couple of days and get this merged. It will be great to tidy up these conventions.

[Copilot]

🟡 Changes recommended

Although the documentation is well-formed and consistent, this is a low-risk change that still warrants a final human confirmation of the canonical prefix/QEP-2 design decisions before approval.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

This PR documents the previously-undocumented NumPy-style commit-message prefix convention (FIX:, DOC:, MAINT:, …) in the contributing guide, resolving the drift into synonyms that issue #902 identified. It adds a "Commit messages" section to docs/source/contributing.rst listing canonical prefixes with one-line definitions and their QEP-2 Type-label mappings, names deprecated synonyms, and updates the CONTRIBUTING.md pointer to mention the new content. The PR-template acceptance-criterion from #902 is intentionally deferred to #892 (the community-files issue), which is noted in the PR description.

Changes:

• Add a "Commit messages" section documenting canonical prefixes, one-line definitions, and QEP-2 Type-label mappings.
• List deprecated synonyms (BUG:, DOCS:, TEST:, IMP:, RELEASE:) and note campaign-specific prefixes.
• Update the CONTRIBUTING.md pointer to reference the new commit-message convention.

File summaries

File	Description
docs/source/contributing.rst	Adds the "Commit messages" section defining canonical prefixes, QEP-2 mappings, and deprecated synonyms.
CONTRIBUTING.md	Updates the guide summary to mention the NumPy-style commit-message prefix convention.

Review details

• Files reviewed: 2/2 changed files
• Comments generated: 0
• Review effort level: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.