Commit ff42f70 1 parent 7534533 commit ff42f70 Copy full SHA for ff42f70
File tree 1 file changed +30
-0
lines changed
1 file changed +30
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Contributing to Vortex
2
+
3
+ Welcome! Thank you for your interest in Vortex. Before contributing, please
4
+ review the guidelines below.
5
+
6
+ ## Reporting Issues
7
+
8
+ Found a bug? Have an improvement to suggest? Please file a
9
+ [ GitHub issue] ( https://github.com/spiraldb/vortex/issues ) .
10
+ Before you create a new issue, please ensure that a relevant issue doesn't
11
+ already exist by running a quick search of existing issues.
12
+ If you're unable to find an open issue, then please open a new one.
13
+
14
+ ## Code Contributions
15
+
16
+ The contribution process is outlined below:
17
+
18
+ 1 . Start a discussion by creating or commenting on a GitHub Issue (unless it's a very minor change).
19
+
20
+ 2 . Implement the change.
21
+ * If the change is large, consider posting a draft pull request (PR)
22
+ with the title prefixed with [ WIP] , and share with the team to get early feedback.
23
+ * Give the PR a clear, brief description; this will be the commit message
24
+ when the PR is merged.
25
+ * Make sure the PR passes all CI tests.
26
+
27
+ 3 . Open a PR to indicate that the change is ready for review.
28
+ * Sign the [ Contributor License Agreement] ( https://cla-assistant.io/spiraldb/vortex ) (CLA) when prompted.
29
+
30
+
You can’t perform that action at this time.
0 commit comments