Skip to content

add contributing guide to CONTRIBUTING.md #662

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add contributing guide to CONTRIBUTING.md #662

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,38 @@
We love contributions from our community ❤️. Please check out our [contributing guide](https://cocoindex.io/docs/about/contributing).
# Contributing

Cocoindex uses GitHub issues to track bugs and manage feature requests.

* If you are a new contributor see: [Quick Start](#quick-start)

* If you have a fix or improvement for the good-first-issues, go ahead and create a pull request.
However, we recommend you to leave a comment on the issue like ***I'm working on it*** or ***Can I work on this issue?***.
This is to avoid duplicating work.

* If you plan to do something more involved, first discuss your ideas
on our [discord server](https://discord.com/invite/zpA9S2DR7s).
This will avoid unnecessary work and surely give you and us a good deal
of inspiration.

## Quick Start

Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue.

Please check the [`good-first-issues`](https://github.com/cocoindex-io/cocoindex/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label to find issues that are good for getting started. If you have questions about one of the issues, with or without the tag, please comment on them and one of the maintainers will clarify it. For a quicker response, contact us via[Discord Server](https://discord.com/invite/zpA9S2DR7s).

For complete instructions on how to: [set up your dev environment](https://cocoindex.io/docs/about/contributing)

All our issues are regularly tagged so that you can also filter down the issues involving the components you want to work on.

## Pull Request Checklist

* Branch from the main branch and, if needed, rebase to the current main branch before submitting your pull request. If it doesn't merge cleanly with main you may be asked to rebase your changes.

* Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).

* If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment, or you can ask for a review on the Dicord channel [cocoindex discord](https://discord.com/invite/zpA9S2DR7s).

* Add tests relevant to the fixed bug or new feature.

## Guide

For more information on contributing, Please refer to the [contributing guide](https://cocoindex.io/docs/about/contributing)