Skip to content

Commit

Permalink
chore(administration): add PR template (#1102)
Browse files Browse the repository at this point in the history
* chore(administration): add PR template

* add section for dd-rust-license-tool

* update changelog comments
  • Loading branch information
pront authored Oct 30, 2024
1 parent 18fd456 commit 929b8a3
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 5 deletions.
70 changes: 70 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<!--
Your PR title must conform to the conventional commit spec:
https://www.conventionalcommits.org/en/v1.0.0/
<type>(<scope>)!: <description>
* `type` = chore, enhancement, feat, fix, docs, revert
* `!` = OPTIONAL: signals a breaking change
* `scope` = Optional when `type` is "chore" or "docs"
* `description` = short description of the change
Examples:
* enhancement(file source): Add `sort` option to sort discovered files
* feat(new source): Initial `statsd` source
* fix(file source): Fix a bug discovering new files
* chore(external docs): Clarify `batch_size` option
-->

## Summary

<!-- Please provide a brief summary about what this PR does.
This should help the reviewers give feedback faster and with higher quality. -->

## Change Type

- [ ] Bug fix
- [ ] New feature
- [ ] Non-functional (chore, refactoring, docs)
- [ ] Performance

## Is this a breaking change?

- [ ] Yes
- [ ] No

## How did you test this PR?

<!-- Please describe your testing plan here.
Providing this information upfront will facilitate a smoother review process. -->

## Does this PR include user facing changes?

- [ ] Yes. Please add a changelog fragment based on
our [guidelines](https://github.com/vectordotdev/vector/blob/master/changelog.d/README.md).
- [ ] No. A maintainer will apply the "no-changelog" label to this PR.

## Checklist

- [ ] Our [CONTRIBUTING.md](https://github.com/vectordotdev/vrl/blob/main/CONTRIBUTING.md) is a good starting place.
- [ ] If this PR introduces changes to [LICENSE-3rdparty.csv](https://github.com/vectordotdev/vrl/blob/main/LICENSE-3rdparty.csv), please
run `dd-rust-license-tool write` and commit the changes. More details [here](https://crates.io/crates/dd-rust-license-tool).
- [ ] For new VRL functions, please also create a sibling PR in Vector to document the new function.

<!-- Examples for the above:
PR adding new VRL function: https://github.com/vectordotdev/vrl/pull/993
PR adding documentation: https://github.com/vectordotdev/vector/pull/21142
We are working towards improving this workflow.
-->

## References

<!-- Please list any issues closed by this PR. -->

<!--
- Closes: <issue link>
-->

<!-- Any other issues or PRs relevant to this PR? Feel free to list them here. -->
8 changes: 3 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@ provide everything you need to get started.

## Steps

1. Ensure your change has an issue! Find an
[existing issue][urls.existing_issues] or [open a new issue][urls.new_issue].
- This is where you can get a feel if the change will be accepted or not.
Changes that are questionable will have a `needs: approval` label.
2. [fork the Vector repository][urls.fork_repo] in your own
1. Ensure your change has an issue!
Find an [existing issue][urls.existing_issues] or [open a new issue][urls.new_issue].
2. [fork the VRL repository][urls.fork_repo] in your own
GitHub account (only applicable to outside contributors).
3. [Create a new Git branch][urls.create_branch].
4. Make your changes.
Expand Down

0 comments on commit 929b8a3

Please sign in to comment.