diff --git "a/.github/ISSUE_TEMPLATE/\360\237\222\241-feature-request.md" "b/.github/ISSUE_TEMPLATE/\360\237\222\241-feature-request.md" index 2f553777..9f96bac3 100644 --- "a/.github/ISSUE_TEMPLATE/\360\237\222\241-feature-request.md" +++ "b/.github/ISSUE_TEMPLATE/\360\237\222\241-feature-request.md" @@ -18,3 +18,7 @@ A clear and concise description of any alternative solutions or features you've **Additional context** Add any other context or screenshots about the feature request here. + +--- +[Contributing Guide](https://cocoindex.io/docs/about/contributing) +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. diff --git a/docs/docs/about/community.md b/docs/docs/about/community.md index e0633ce4..ac577ff7 100644 --- a/docs/docs/about/community.md +++ b/docs/docs/about/community.md @@ -29,7 +29,7 @@ Join our community channels to get help, share ideas, and connect with other dev Need help? Here are the best ways to get support: -- Email us at [support@cocoindex.io](mailto:support@cocoindex.io) +- Email us at [hi@cocoindex.io](mailto:hi@cocoindex.io) - Check our [documentation](https://cocoindex.io/docs) - Read our [blog posts](https://cocoindex.io/blogs) -- Ask questions in our Discord community \ No newline at end of file +- Ask questions in our [Discord Server](https://discord.com/invite/zpA9S2DR7s) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index 73925128..a366c68c 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -5,9 +5,23 @@ description: Learn how to contribute to CocoIndex # Contributing -We love contributions from our community! This guide explains how to get involved and contribute to CocoIndex. +[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). -## Setting Up Development Environment +## Issues: + +We use [GitHub Issues](https://github.com/cocoindex-io/cocoindex/issues) to track bugs and feature requests. + +## Good First Issues + +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. + +## How to Contribute +- 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. +- 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. +- 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. + +## Start hacking! Setting Up Development Environment +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. - Install Rust toolchain: [docs](https://rust-lang.org/tools/install) @@ -48,7 +62,6 @@ To submit your code: In your PR description, please include: - Description of the changes - Motivation and context -- Test coverage details - Note if it's a breaking change - Reference any related GitHub issues