Skip to content

Pr formatting guidelines#2015

Merged
jxnl merged 1 commit intomainfrom
cursor/567-273-pr-formatting-guidelines-2203
Jan 18, 2026
Merged

Pr formatting guidelines#2015
jxnl merged 1 commit intomainfrom
cursor/567-273-pr-formatting-guidelines-2203

Conversation

@jxnl
Copy link
Collaborator

@jxnl jxnl commented Jan 17, 2026

docs(agents): add conventional commit PR formatting guidelines

Describe your changes

This PR addresses Linear issue 567-273 by adding comprehensive Pull Request (PR) formatting guidelines to AGENT.md and docs/AGENT.md. The goal is to standardize PR titles using Conventional Commits and provide clear guidelines for PR descriptions, improving consistency and reviewability across agent-related contributions.

The guidelines include:

  • Conventional Commits format, rules, examples, and common types for PR titles.
  • Suggested scopes tailored to the respective AGENT.md file (general vs. docs-specific).
  • A checklist for PR descriptions covering "What," "Why," "Changes," and "Testing."
  • A specific convention for Cursor-authored PRs.

Issue ticket number and link

567-273: Add PR formatting guidelines to agents.md using conventional commits

Checklist before requesting a review

  • I have performed a self-review of my code
  • If it is a core feature, I have added thorough tests.
  • If it is a core feature, I have added documentation.

Linear Issue: 567-273

Open in Cursor Open in Web


Note

Standardizes PR structure across agent and docs guides.

  • Adds PR Formatting section to AGENT.md and docs/AGENT.md
  • Defines Conventional Commits title format, rules, examples, common types, and suggested scopes
  • Introduces concise PR description checklist (What/Why/Changes/Testing) and Cursor-authored note
  • Tailors scopes/examples for general repo vs. docs
  • Documentation-only changes

Written by Cursor Bugbot for commit ad452ab. Configure here.

@cursor
Copy link

cursor bot commented Jan 17, 2026

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@cloudflare-workers-and-pages
Copy link

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
instructor ad452ab Commit Preview URL

Branch Preview URL
Jan 17 2026, 05:56 PM

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request size:M This PR changes 30-99 lines, ignoring generated files. labels Jan 17, 2026
@jxnl jxnl marked this pull request as ready for review January 18, 2026 18:37
@jxnl jxnl merged commit 3fe0c76 into main Jan 18, 2026
17 checks passed
@jxnl jxnl deleted the cursor/567-273-pr-formatting-guidelines-2203 branch January 18, 2026 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants