Skip to content

Development standards checklist#105

Closed
epkvignesh-rp wants to merge 1 commit intomainfrom
cursor/development-standards-checklist-45c4
Closed

Development standards checklist#105
epkvignesh-rp wants to merge 1 commit intomainfrom
cursor/development-standards-checklist-45c4

Conversation

@epkvignesh-rp
Copy link

Description

  • Adds a comprehensive development standards checklist to README.md.
  • Integrates a concise, CI-aligned checklist into .github/pull_request_template.md.

Jira Issue: https://revolutionparts.atlassian.net/browse/DOCS-123

Background

This PR addresses the need for a centralized development standards checklist, derived from existing repository standards and common PR review feedback. The goal is to improve consistency and quality by providing clear guidelines for developers and a quick reference within the PR creation process.

Testing Information

  • Verified that the new checklist in README.md accurately reflects existing CI checks (Jira, commitlint, actionlint) and common review feedback.
  • Confirmed that the updated .github/pull_request_template.md includes the new, concise checklist.
  • Ensured all links and formatting are correct in both updated files.

Checklist

  • Jira: Jira key present (branch name / PR title / PR description) and Jira link filled in above
  • PR title: includes Jira key (recommended: [PROJECT-1234] ...)
  • Commits: conventional commits format (type(scope): subject)
  • Quality: lint/format/static-analysis run and clean (as applicable)
  • Tests: run and passing; added/updated tests where behavior changed
  • Type safety (PHP/TS): explicit types; arrays/shapes documented where needed; no empty() in PHP
  • GitHub Actions changes (if applicable): actionlint clean; avoid interpolating PR title/body directly in run: (pass via env:)

Open in Cursor Open in Web

Co-authored-by: Vignesh Krishnamoorthy <epkvignesh-rp@users.noreply.github.com>
@cursor
Copy link

cursor bot commented Feb 15, 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

@cursor
Copy link

cursor bot commented Feb 15, 2026

PR Summary

Low Risk
Documentation/template-only changes with no runtime, security, or data-handling impact.

Overview
Adds a centralized development standards checklist to README.md, covering PR metadata, branching/commit conventions, local quality checks, type-safety guidelines, and GitHub Actions/shell safety expectations.

Updates .github/pull_request_template.md to include a concise, CI-aligned checklist (Jira key/link, PR title format, conventional commits, quality/tests, type safety, and safe Actions scripting) to standardize what authors verify before requesting review.

Written by Cursor Bugbot for commit e31090a. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants