|
| 1 | +<!-- |
| 2 | + Your PR title must conform to the conventional commit spec: |
| 3 | + https://www.conventionalcommits.org/en/v1.0.0/ |
| 4 | +
|
| 5 | + <type>(<scope>)!: <description> |
| 6 | +
|
| 7 | + * `type` = chore, enhancement, feat, fix, docs, revert |
| 8 | + * `!` = OPTIONAL: signals a breaking change |
| 9 | + * `scope` = Optional when `type` is "chore" or "docs" |
| 10 | + * `description` = short description of the change |
| 11 | +
|
| 12 | +Examples: |
| 13 | +
|
| 14 | + * enhancement(file source): Add `sort` option to sort discovered files |
| 15 | + * feat(new source): Initial `statsd` source |
| 16 | + * fix(file source): Fix a bug discovering new files |
| 17 | + * chore(external docs): Clarify `batch_size` option |
| 18 | +--> |
| 19 | + |
| 20 | +## Summary |
| 21 | + |
| 22 | +<!-- Please provide a brief summary about what this PR does. |
| 23 | +This should help the reviewers give feedback faster and with higher quality. --> |
| 24 | + |
| 25 | +## Change Type |
| 26 | + |
| 27 | +- [ ] Bug fix |
| 28 | +- [ ] New feature |
| 29 | +- [ ] Non-functional (chore, refactoring, docs) |
| 30 | +- [ ] Performance |
| 31 | + |
| 32 | +## Is this a breaking change? |
| 33 | + |
| 34 | +- [ ] Yes |
| 35 | +- [ ] No |
| 36 | + |
| 37 | +## How did you test this PR? |
| 38 | + |
| 39 | +<!-- Please describe your testing plan here. |
| 40 | +Providing this information upfront will facilitate a smoother review process. --> |
| 41 | + |
| 42 | +## Does this PR include user facing changes? |
| 43 | + |
| 44 | +- [ ] Yes. Please add a changelog fragment based on |
| 45 | + our [guidelines](https://github.com/vectordotdev/vector/blob/master/changelog.d/README.md). |
| 46 | +- [ ] No. A maintainer will apply the "no-changelog" label to this PR. |
| 47 | + |
| 48 | +## Checklist |
| 49 | + |
| 50 | +- [ ] Our [CONTRIBUTING.md](https://github.com/vectordotdev/vrl/blob/main/CONTRIBUTING.md) is a good starting place. |
| 51 | +- [ ] If this PR introduces changes to [LICENSE-3rdparty.csv](https://github.com/vectordotdev/vrl/blob/main/LICENSE-3rdparty.csv), please |
| 52 | + run `dd-rust-license-tool write` and commit the changes. More details [here](https://crates.io/crates/dd-rust-license-tool). |
| 53 | +- [ ] For new VRL functions, please also create a sibling PR in Vector to document the new function. |
| 54 | + |
| 55 | +<!-- Examples for the above: |
| 56 | + PR adding new VRL function: https://github.com/vectordotdev/vrl/pull/993 |
| 57 | + PR adding documentation: https://github.com/vectordotdev/vector/pull/21142 |
| 58 | + |
| 59 | + We are working towards improving this workflow. |
| 60 | +--> |
| 61 | + |
| 62 | +## References |
| 63 | + |
| 64 | +<!-- Please list any issues closed by this PR. --> |
| 65 | + |
| 66 | +<!-- |
| 67 | +- Closes: <issue link> |
| 68 | +--> |
| 69 | + |
| 70 | +<!-- Any other issues or PRs relevant to this PR? Feel free to list them here. --> |
0 commit comments