You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/about/community.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ We are super excited for community contributions of all kinds - whether it's cod
12
12
We would love to foster an inclusive, welcoming, and supportive environment. Contributing to CocoIndex should feel collaborative, friendly and enjoyable for everyone. Together, we can build better AI applications through robust data infrastructure.
13
13
14
14
:::tip Start hacking CocoIndex
15
-
Check out our [Contributing guide](./contributing) to get started!
15
+
Check out our [Contributing guide](/docs/contributing/guide) to get started!
[CocoIndex](https://github.com/cocoindex-io/cocoindex) is an open source project. We are respectful, open and friendly. This guide explains how to get involved and contribute to [CocoIndex](https://github.com/cocoindex-io/cocoindex).
9
7
10
-
## Issues:
11
-
12
-
We use [GitHub Issues](https://github.com/cocoindex-io/cocoindex/issues) to track bugs and feature requests.
8
+
Our [Discord server](https://discord.com/invite/zpA9S2DR7s) is constantly open.
9
+
If you are unsure about anything, it is a good place to discuss! We'd love to collaborate and will always be friendly.
13
10
14
11
## Good First Issues
15
12
16
13
We tag issues with the ["good first issue"](https://github.com/cocoindex-io/cocoindex/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label for beginner contributors.
17
14
18
15
## How to Contribute
19
-
- If you decide to work on an issue, unless the PR can be sent immediately (e.g. just a few lines of code), we recommend you to leave a comment on the issue like **`I'm working on it`** or **`Can I work on this issue?`**to avoid duplicating work.
16
+
- If you decide to take an issue, we recommend you to leave a comment on the issue like **`Can I work on this issue?`**so we could assign it to you. This helps you and others avoid duplicating work.
20
17
- For larger features, we recommend you to discuss with us first in our [Discord server](https://discord.com/invite/zpA9S2DR7s) to coordinate the design and work.
21
-
- Our [Discord server](https://discord.com/invite/zpA9S2DR7s) is constantly open. If you are unsure about anything, it is a good place to discuss! We'd love to collaborate and will always be friendly.
22
-
23
-
## Start hacking! Setting Up Development Environment
24
-
Follow the steps below to get cocoindex built on the latest codebase locally - if you are making changes to cocoindex functionality and want to test it out.
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
31
-
```
32
-
Already have Rust? Make sure it's up to date
33
-
```sh
34
-
rustup update
35
-
```
36
-
37
-
- Setup Python virtual environment:
38
-
```sh
39
-
python3 -m venv .venv
40
-
```
41
-
Activate the virtual environment, before any installing / building / running:
42
-
43
-
```sh
44
-
. .venv/bin/activate
45
-
```
46
-
47
-
- Install required tools:
48
-
```sh
49
-
pip install maturin
50
-
```
51
-
52
-
- Build the library. Run at the root of cocoindex directory:
53
-
```sh
54
-
maturin develop -E all,dev
55
-
```
56
-
57
-
- Install and enable pre-commit hooks. This ensures all checks run automatically before each commit:
58
-
```sh
59
-
pre-commit install
60
-
```
61
-
62
-
- Before running a specific example, set extra environment variables, for exposing extra traces, allowing dev UI, etc.
63
-
```sh
64
-
. ./.env.lib_debug
65
-
```
66
18
67
19
## Submit Your Code
68
20
CocoIndex is committed to the highest standards of code quality. Please ensure your code is thoroughly tested before submitting a PR.
@@ -89,6 +41,7 @@ In your PR description, please include:
89
41
- Note if it's a breaking change
90
42
- Reference any related GitHub issues
91
43
44
+
92
45
A core team member will review your PR within one business day and provide feedback on any required changes. Once approved and all tests pass, the reviewer will squash and merge your PR into the main branch.
93
46
94
47
Your contribution will then be part of CocoIndex! We'll highlight your contribution in our release notes 🌴.
description: Learn how to setup your development environment to develop CocoIndex
4
+
---
5
+
6
+
Follow the steps below to get CocoIndex built on the latest codebase locally - if you are making changes to CocoIndex functionality and want to test it out.
0 commit comments