Sponsored Content
Skip to content

ci: Move Type of Change from PR template to CONTRIBUTING - #6522

Merged
bthomee merged 8 commits into
XRPLF:developfrom
mathbunnyru:update_pr_template
Mar 12, 2026
Merged

ci: Move Type of Change from PR template to CONTRIBUTING#6522
bthomee merged 8 commits into
XRPLF:developfrom
mathbunnyru:update_pr_template

Conversation

@mathbunnyru

@mathbunnyru mathbunnyru commented Mar 11, 2026

Copy link
Copy Markdown
Contributor

High Level Overview of Change

Since we use validated prefix, this is no longer needed, and is not needed to be checked.
I also adapted the list to the new prefixes, updated descriptions and put them to CONTRIBUTING file.

Context of Change

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking change that only restructures code)
  • Performance (increase or change in throughput and/or latency)
  • Tests (you added tests for code that already exists, or your new feature included in this PR)
  • Documentation update
  • Chore (no impact to binary, e.g. .gitignore, formatting, dropping support for older tooling)
  • Release

API Impact

  • Public API: New feature (new methods and/or new fields)
  • Public API: Breaking change (in general, breaking changes should only impact the next api_version)
  • libxrpl change (any change that may affect libxrpl or dependents of libxrpl)
  • Peer protocol change (must be backward compatible or bump the peer protocol version)

@mathbunnyru
mathbunnyru requested a review from bthomee March 11, 2026 11:12
Comment thread .github/pull_request_template.md Outdated
@mathbunnyru mathbunnyru changed the title ci: Update Type of Change in PR template ci: Move Type of Change from PR template to CONTRIBUTING Mar 11, 2026
@mathbunnyru
mathbunnyru requested a review from bthomee March 11, 2026 13:57
Comment thread CONTRIBUTING.md
- `perf:` - The primary purpose is performance improvements.
- `chore:` - Other tasks that don't affect the binary, but don't fit any of the other cases. e.g. `git` settings, `clang-tidy`, removing dead code, dropping support for older tooling.

First letter after the type prefix should be capitalized, and the type prefix should be followed by a colon and a space. e.g. `feat: Add support for Borrowing Protocol`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we enforcing this rule? Just trying to understand

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes the automatic changelog look nice and uniform, for example: https://github.com/XRPLF/clio/releases/tag/2.7.0

Comment thread CONTRIBUTING.md Outdated
@mathbunnyru
mathbunnyru requested a review from bthomee March 12, 2026 04:18
@mathbunnyru mathbunnyru added Trivial Simple change with minimal effect, or already tested. Only needs one approval. Ready to merge *PR author* thinks it's ready to merge. Has passed code review. Perf sign-off may still be required. labels Mar 12, 2026
@bthomee
bthomee merged commit e460ea0 into XRPLF:develop Mar 12, 2026
1 check passed
@mvadari mvadari added this to the 3.2.0 milestone May 20, 2026
beartec-jpg pushed a commit to beartec-jpg/FalconLedger that referenced this pull request Jun 1, 2026
Now that prefixes in PR titles are being validated as part of CI, the "Type of Change" section in the PR template is no longer needed. The prefixes and descriptions in the `CONTRIBUTING.md` file have been updated to reflect the currently supported list.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Ready to merge *PR author* thinks it's ready to merge. Has passed code review. Perf sign-off may still be required. Trivial Simple change with minimal effect, or already tested. Only needs one approval.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants