Skip to content

chore(contributing): align contribution conventions - #66

Merged
jingxiang-z merged 2 commits into
mainfrom
chore/align-contribution-conventions
Oct 1, 2026
Merged

jingxiang-z merged 2 commits into
mainfrom
chore/align-contribution-conventions

Conversation

@jingxiang-z

@jingxiang-z jingxiang-z commented Oct 1, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Checklist

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidance with commit and pull request formatting, sign-off, branch naming, and merge requirements.
    • Updated the pull request template with breaking-change and validation sections.
  • Chores
    • Added automatic validation of pull request titles against the project’s accepted format.

Signed-off-by: Jingxiang Zhang <jingzhang@nvidia.com>
Signed-off-by: Jingxiang Zhang <jingzhang@nvidia.com>
@coderabbitai

coderabbitai Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: NVIDIA/fleet-intelligence-client/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 97686838-a3db-40f5-bfa6-c7e47201c22a

📥 Commits

Reviewing files that changed from the base of the PR and between 1b96f1b and b1549a6.

📒 Files selected for processing (3)
  • .github/PULL_REQUEST_TEMPLATE.md
  • .github/workflows/contribution-conventions.yml
  • CONTRIBUTING.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.


📝 Walkthrough

Walkthrough

The pull request adds shared contribution guidance, updates the pull request template, and introduces a GitHub Actions check that validates pull request titles.

Changes

Contribution conventions

Layer / File(s) Summary
Document contribution conventions
.github/PULL_REQUEST_TEMPLATE.md, CONTRIBUTING.md
The template adds title-format guidance, breaking-change and validation prompts, and a sign-off requirement. CONTRIBUTING.md describes commit and pull request conventions, and links local hooks guidance to the shared conventions.
Validate pull request titles
.github/workflows/contribution-conventions.yml, CONTRIBUTING.md
The workflow checks pull request titles on specified events and fails titles that do not match the allowed format. CONTRIBUTING.md describes the check and its configuration.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to b1549

This PR adds contribution guidance and a title-format check. The check treats titles as data and enforces the documented format; no actionable merge risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: aligning contribution conventions across the PR template, workflow, and CONTRIBUTING.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


Comment @coderabbitai help to get the list of available commands.

@jingxiang-z
jingxiang-z merged commit 0acd825 into main Oct 1, 2026
10 checks passed
@jingxiang-z
jingxiang-z deleted the chore/align-contribution-conventions branch October 1, 2026 21:40
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