Skip to content

Commit 99e85c3

Browse files
committed
Add CONTRIBUTING.md
1 parent 08b618a commit 99e85c3

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!--
2+
# SPDX-License-Identifier: Apache-2.0
3+
# SPDX-FileCopyrightText: 2025 DBVisor
4+
-->
5+
6+
# Contributing to SQL
7+
8+
We invite contributions to SQL, in order for you to commit with confindance
9+
you can create the database with `mix sql.create`
10+
and explore the library in `iex -S mix`.
11+
12+
For conformance testing you'll need to clone https://github.com/elliotchance/sqltest
13+
and run `mix sql.gen.test ../sqltest/standards/2016`.
14+
15+
You can run benchmarks with `mix sql.bench`, remember that performance can differ
16+
based on concurrency.
17+
18+
As we're pre 1.0, then breaking changes are allowed, although they will only be merged, if
19+
they improve: userability, correctness and performance.

0 commit comments

Comments
 (0)