Skip to content

docs: update release notes and add AGENTS.md for project guidelines#245

Merged
shenxianpeng merged 1 commit into
mainfrom
feature/update-draft-release
Jun 19, 2026
Merged

docs: update release notes and add AGENTS.md for project guidelines#245
shenxianpeng merged 1 commit into
mainfrom
feature/update-draft-release

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Jun 19, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation

    • Updated release notes generation wording.
    • Added contributor workflow guidance documentation.
  • Chores

    • Removed internal AI coding guide documentation.

No user-facing changes in this release.

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Jun 19, 2026
@github-actions github-actions Bot added the enhancement New feature or request label Jun 19, 2026
@shenxianpeng shenxianpeng removed the enhancement New feature or request label Jun 19, 2026
@shenxianpeng shenxianpeng merged commit 9fb955a into main Jun 19, 2026
25 of 27 checks passed
@shenxianpeng shenxianpeng deleted the feature/update-draft-release branch June 19, 2026 18:08
@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b55baf97-aa4b-46cb-b48e-818fb78fcedc

📥 Commits

Reviewing files that changed from the base of the PR and between 2d1b963 and 6124424.

📒 Files selected for processing (3)
  • .github/copilot-instructions.md
  • .github/workflows/release-drafter.yml
  • AGENTS.md

Walkthrough

Removes .github/copilot-instructions.md (109 lines), adds AGENTS.md with Git workflow rules, project overview, hook behavior patterns, and CI summary. Updates the release-drafter workflow to reword the default clang tool versions header describing dynamic PyPI resolution and --version pinning.

Changes

Documentation and Release-Drafter Update

Layer / File(s) Summary
Add AGENTS.md contributor guide
AGENTS.md
Adds 53-line contributor guide covering mandatory Git/PR rules (no direct main commits, no force-push), a project overview table mapping key files to roles, core hook behavioral patterns (PyPI-based version resolution, return codes, compile DB detection, --jobs parallelism), and a CI configuration summary. Replaces the removed .github/copilot-instructions.md.
Update release-drafter version note wording
.github/workflows/release-drafter.yml
Rewrites the three-line block emitted for the "Default Clang Tool Versions" section, stating versions are resolved dynamically from PyPI at hook runtime, latest stable versions are used by default, and pinning is done via --version under args.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@sonarqubecloud

Copy link
Copy Markdown

@codecov

codecov Bot commented Jun 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.51%. Comparing base (2d1b963) to head (6124424).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #245   +/-   ##
=======================================
  Coverage   97.51%   97.51%           
=======================================
  Files           3        3           
  Lines         241      241           
=======================================
  Hits          235      235           
  Misses          6        6           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant