Skip to content

Commit d90f124

Browse files
authored
docs: Update CONTRIBUTING.md to include PR label guidelines for auto (#514)
<!-- CURSOR_SUMMARY --> > [!NOTE] > **Low Risk** > Low risk documentation-only update plus a lockfile metadata/version bump; no runtime code paths change, though the `uv.lock` update could cause minor churn if committed without corresponding dependency changes. > > **Overview** > Updates `CONTRIBUTING.md` to document required `auto:*` PR labels (with a label/semver mapping) and adds the label requirement to the PR checklist. > > Bumps `uv.lock` metadata (`revision` to 3) and updates the editable `redisvl` package entry from `0.14.0` to `0.14.1`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 4e38cb9. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent b8d7067 commit d90f124

2 files changed

Lines changed: 21 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,24 @@ Before suggesting a new feature:
266266
- After feedback, we expect a response within two weeks
267267
- PRs may be closed if they show no activity after this period
268268

269+
### PR Labels
270+
271+
This project uses an automated release process powered by [Auto](https://intuit.github.io/auto/). PRs must be labeled to indicate the type of change:
272+
273+
| Label | Description |
274+
|-------|-------------|
275+
| `auto:major` | Breaking changes (bumps major version) |
276+
| `auto:minor` | New features/enhancements (bumps minor version) |
277+
| `auto:patch` | Bug fixes (bumps patch version) |
278+
| `auto:performance` | Performance improvements (bumps patch version) |
279+
| `auto:documentation` | Documentation-only changes (no version bump) |
280+
| `auto:tests` | Test additions/improvements (no version bump) |
281+
| `auto:dependencies` | Dependency updates (no version bump) |
282+
| `auto:internal` | Internal changes (no version bump) |
283+
| `auto:ci` | CI/CD workflow changes (no version bump) |
284+
285+
If you are unsure about which label to use, ask in the PR and a maintainer will help you.
286+
269287
### PR Checklist
270288

271289
Before submitting your PR, ensure:
@@ -275,6 +293,7 @@ Before submitting your PR, ensure:
275293
- [ ] Documentation is updated if needed
276294
- [ ] Commit messages are clear and descriptive
277295
- [ ] PR description explains what changes were made and why
296+
- [ ] Appropriate `auto:*` label is applied to indicate the change type
278297

279298
## Getting Help
280299

uv.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)