Skip to content

Latest commit

 

History

History
28 lines (24 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

28 lines (24 loc) · 1.71 KB
Raw

Contributing

First, thank you for contributing to VRL! The goal of this document is to provide everything you need to get started.

Steps

  1. For large PRs, breaking changes or if you just want feedback from us and the community, open a new issue. Please take a look at existing issues to avoid duplicates.
  2. Fork the VRL repository in your own GitHub account (only applicable to outside contributors).
  3. Create a new Git 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. These checks are also run by the CI.
  7. Submit the branch as a pull request 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 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.