apache / apache/hugegraph

[Doc] Contribution Guidelines & Quick Start for HugeGraph

Open
#2,212 5 comments 8 reactions 0 assignees View on GitHub
apache doc good first issue help wanted
Dominant language
Java
Stars
3.2k
Forks
636
Avg merge
3d 11h
Merged PRs (30d)
14

Description

### Description (简介)

**Hi, everyone👋**

Recently, the community has welcomed many new guys. To let everyone get familiar with the project and participate in the community faster, we created this issue to give you some guidance. If you have any questions, can reply in this issue.

The HugeGraph community includes 5 repositories:
1. [hugegraph-server](https://github.com/apache/hugegraph) (graph's core component - OLTP server + pd + storage)
2. [hugegraph-toolchain](https://github.com/apache/hugegraph-toolchain) (include loader/dashboard/tool/client)
3. [hugegraph-computer](https://github.com/apache/hugegraph-computer) (2 graph computing system - OLAP)
4. [hugegraph-ai](https://github.com/apache/incubator-hugegraph-ai) LLM/Graph RAG/Agent....
5. [hugegraph-website/doc](https://github.com/apache/hugegraph-doc) (include doc & website code)

Now, u could get more module/repo info from LLM summary🤖:
- https://deepwiki.com/apache/hugegraph
- https://deepwiki.com/apache/hugegraph-toolchain
- https://deepwiki.com/apache/incubator-hugegraph-ai
- .....(so as others)

# Preparation (Useful)

- Configs & [Development environment](https://github.com/apache/incubator-hugegraph/wiki/The-style-config-for-HugeGraph-in-IDEA) (Recommended)
* [Setup Server in IDEA](https://hugegraph.apache.org/docs/contribution-guidelines/hugegraph-server-idea-setup/) (WIKI)
- Read [contribution guidelines](https://hugegraph.apache.org/cn/docs/contribution-guidelines/contribute/)
- [How to Subscribe](https://hugegraph.apache.org/cn/docs/contribution-guidelines/subscribe/) the `dev@hugegraph mailing` list

# What can I do for the community/start?

0. Submit issue & call `Dosu-robot` 🤖 to get lots of help (source code understanding/bug/feature proposal/...)
1. Reply issues to help users solve problems.
2. Submit PR to fix bugs or add new features.
3. Help review code.
4. Help users solve problems in `Slack/WeChat` group.

# Task lists (Participate in it)

All the issues which has [**good first issue**](https://github.com/apache/incubator-hugegraph/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22) label in the 6 repository are very suitable for new guys (view summary [here](https://github.com/orgs/apache/projects/263/views/1?query=is%3Aopen+sort%3Aupdated-desc) & check "**Newcomer Tasks**" first)

Also could refer https://github.com/apache/incubator-hugegraph/issues/2764

if you are interested, just reply in the issue. (Also could enhance the [doc](https://github.com/apache/incubator-hugegraph-doc/issues/260)/website for your first contribution)

🎯 **We can also find all new tasks and manage projects [here](https://github.com/orgs/apache/projects/263)** (Task Summary)👈👈👈

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.