Skip to content

github: rewrite PR guide for clarity and detail#294

Merged
j-d-ha merged 2 commits into
mainfrom
feature/update-xml-formatters
Jan 25, 2026
Merged

github: rewrite PR guide for clarity and detail#294
j-d-ha merged 2 commits into
mainfrom
feature/update-xml-formatters

Conversation

@j-d-ha

@j-d-ha j-d-ha commented Jan 25, 2026

Copy link
Copy Markdown
Collaborator

🚀 Pull Request

📋 Summary

This PR includes two sets of improvements:

  1. Documentation Enhancement: Complete rewrite of .claude/commands/pr.md with:

    • Comprehensive workflow guide for creating PRs
    • Strict conventional commit format validation rules
    • Detailed type and scope reference tables
    • Examples of valid and invalid PR titles
    • Best practices for auto-suggesting titles and PR body content
  2. XML Formatting Improvements:

    • Reformatted Directory.Packages.props for consistency (changed XML attributes to use self-closing tags without spaces)
    • Updated tasks/FormattingTasks.yml to exclude **.props files from CleanupCode to preserve manual formatting

✅ Checklist

  • My changes build cleanly
  • I've added/updated relevant tests
  • I've added/updated documentation or README
  • I've followed the coding style for this project
  • I've tested the changes locally (if applicable)

🧪 Related Issues or PRs

N/A


💬 Notes for Reviewers

The documentation changes significantly expand the PR guide with validation rules and examples to help ensure PR titles follow conventional commit format. The formatting changes are minor but important for maintaining consistent XML formatting in package management files.

- Added exclusion of `**.props` files in `CleanupCode` task to prevent unintended processing.
- Removed unnecessary whitespaces from `Directory.Packages.props` file for consistent formatting.
@github-actions github-actions Bot added the type: test Test changes label Jan 25, 2026
@j-d-ha j-d-ha changed the title test(DefaultLambdaCancellationFactory): add intentionally failing test test(testing): add intentionally failing test Jan 25, 2026
@codecov

codecov Bot commented Jan 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #294      +/-   ##
==========================================
+ Coverage   87.32%   87.35%   +0.03%     
==========================================
  Files         131      131              
  Lines        2919     2919              
  Branches      351      351              
==========================================
+ Hits         2549     2550       +1     
+ Misses        269      268       -1     
  Partials      101      101              

see 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ac4874c...0b795ef. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

- Expanded the PR creation guide with stricter conventional commit validation rules.
- Added detailed PR workflows, including pre-flight checks, title validation, and auto-suggestions.
- Provided updated templates for PR body and title examples for user guidance.
- Included troubleshooting tips and edge-case guidance for handling scopes and titles.
@j-d-ha j-d-ha changed the title test(testing): add intentionally failing test docs(commands): rewrite PR guide for clarity and detail Jan 25, 2026
@sonarqubecloud

Copy link
Copy Markdown

@j-d-ha j-d-ha changed the title docs(commands): rewrite PR guide for clarity and detail github: rewrite PR guide for clarity and detail Jan 25, 2026
@j-d-ha
j-d-ha merged commit 1e066c4 into main Jan 25, 2026
8 of 10 checks passed
@j-d-ha
j-d-ha deleted the feature/update-xml-formatters branch January 25, 2026 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: test Test changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant