From d0132a5b2f53e62d92b4527a409810c24e955ef6 Mon Sep 17 00:00:00 2001 From: Will Manning Date: Tue, 11 Jun 2024 11:18:17 +0200 Subject: [PATCH] add CONTRIBUTING.md with CLA instructions --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..f571457eee --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to Vortex + +Welcome! Thank you for your interest in Vortex. Before contributing, please +review the guidelines below. + +## Reporting Issues + +Found a bug? Have an improvement to suggest? Please file a +[GitHub issue](https://github.com/spiraldb/vortex/issues). +Before you create a new issue, please ensure that a relevant issue doesn't +already exist by running a quick search of existing issues. +If you're unable to find an open issue, then please open a new one. + +## Code Contributions + +The contribution process is outlined below: + +1. Start a discussion by creating or commenting on a GitHub Issue (unless it's a very minor change). + +2. Implement the change. + * If the change is large, consider posting a draft pull request (PR) + with the title prefixed with [WIP], and share with the team to get early feedback. + * Give the PR a clear, brief description; this will be the commit message + when the PR is merged. + * Make sure the PR passes all CI tests. + +3. Open a PR to indicate that the change is ready for review. + * Sign the [Contributor License Agreement](https://cla.spiraldb.com) (CLA) when prompted. + +