Skip to content

Commit

Permalink
add CONTRIBUTING.md with CLA instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lwwmanning committed Jun 11, 2024
1 parent 0e83666 commit d0132a5
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.


0 comments on commit d0132a5

Please sign in to comment.