Skip to content

Commit f24aea7

Browse files
authored
Improve contributing guide (#358)
1 parent d303296 commit f24aea7

File tree

3 files changed

+22
-5
lines changed

3 files changed

+22
-5
lines changed

.github/ISSUE_TEMPLATE/💡-feature-request.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,7 @@ A clear and concise description of any alternative solutions or features you've
1818

1919
**Additional context**
2020
Add any other context or screenshots about the feature request here.
21+
22+
---
23+
[Contributing Guide](https://cocoindex.io/docs/about/contributing)
24+
For changes that takes more than a day, 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.

docs/docs/about/community.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Join our community channels to get help, share ideas, and connect with other dev
2929

3030
Need help? Here are the best ways to get support:
3131

32-
- Email us at [support@cocoindex.io](mailto:support@cocoindex.io)
32+
- Email us at [hi@cocoindex.io](mailto:hi@cocoindex.io)
3333
- Check our [documentation](https://cocoindex.io/docs)
3434
- Read our [blog posts](https://cocoindex.io/blogs)
35-
- Ask questions in our Discord community
35+
- Ask questions in our [Discord Server](https://discord.com/invite/zpA9S2DR7s)

docs/docs/about/contributing.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,23 @@ description: Learn how to contribute to CocoIndex
55

66
# Contributing
77

8-
We love contributions from our community! This guide explains how to get involved and contribute to CocoIndex.
8+
[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).
99

10-
## Setting Up Development Environment
10+
## Issues:
11+
12+
We use [GitHub Issues](https://github.com/cocoindex-io/cocoindex/issues) to track bugs and feature requests.
13+
14+
## Good First Issues
15+
16+
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+
18+
## 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.
20+
- 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) are 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+
Following the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out.
1125

1226
- Install Rust toolchain: [docs](https://rust-lang.org/tools/install)
1327

@@ -48,7 +62,6 @@ To submit your code:
4862
In your PR description, please include:
4963
- Description of the changes
5064
- Motivation and context
51-
- Test coverage details
5265
- Note if it's a breaking change
5366
- Reference any related GitHub issues
5467

0 commit comments

Comments
 (0)