Skip to content

Commit

Permalink
docs(external): CONTRIBUTING.md enhancements (#1205)
Browse files Browse the repository at this point in the history
* docs(external): CONTRIBUTING.md enhancements

* fix
  • Loading branch information
pront authored Jan 3, 2025
1 parent 3c82c74 commit 017a4fd
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,21 @@ 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].
2. [fork the VRL repository][urls.fork_repo] in your own
1. For large PRs, breaking changes or if you just want feedback from us and the community, [open a new issue][urls.new_issue]. Please take a
look at
[existing issues][urls.existing_issues] to avoid duplicates.
2. [Fork][urls.fork_repo] the VRL repository in your own
GitHub account (only applicable to outside contributors).
3. [Create a new Git branch][urls.create_branch].
4. Make your changes.
5. Add and/or update tests to cover your changes.
6. Run `./scripts/checks.sh` to run tests and other checks.
6. Run `./scripts/checks.sh` to run tests and other checks. These checks are also run by the CI.
7. [Submit the branch as a pull request][urls.submit_pr] to the repo. A team member should
comment and/or review your pull request.
8. Add a changelog fragment (requires the PR number) to describe your changes which will
be included in the release changelog. See the [README.md](changelog.d/README.md) for details.
9. It is normal to have multiple review iterations on a PR. To enable incremental reviews, please try to avoid force pushing if possible.
- When a rebase is needed, try `git merge origin main` followed by `git push`.

[urls.existing_issues]: https://github.com/vectordotdev/vrl/issues
[urls.new_issue]: https://github.com/vectordotdev/vrl/issues/new
Expand Down

0 comments on commit 017a4fd

Please sign in to comment.