[Doc] Contribution Guidelines & Quick Start for HugeGraph

[simon824]

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 (graph's core component - OLTP server + pd + storage)
2. hugegraph-toolchain (include loader/dashboard/tool/client)
3. hugegraph-computer (2 graph computing system - OLAP)
4. hugegraph-ai LLM/Graph RAG/Agent....
5. hugegraph-website/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 (Recommended)
  • Setup Server in IDEA (WIKI)
• Read contribution guidelines
• How to 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 label in the 6 repository are very suitable for new guys (view summary here & 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/website for your first contribution)

🎯 We can also find all new tasks and manage projects here (Task Summary)👈👈👈

[liuxiaocs7]

lack EN version for the legacy article/slides now 😿

Quick Start (CN version)

• HugeGraph QuickStart
• HugeGraph 相关文档/文章/Slide (参考资料)
• 深入学习Gremlin 系列
• Ask ChatGPT/New Bing/*GPT anything about the usage or code meaning (JUST TRY TO ASK IT~)

Before Development

• 贡献指南

Task/Activity

• Beginner Tasks - Summary
• GSoC/OSPP/GLCC.. (🚧)

[snehanemadi]

Hi, This is Sneha, I'm really interested work on this project https://github.com/apache/incubator-hugegraph/wiki/Graph-Traversal-Expansion in GSoC'24, could anyone please let me know from where i can start ? I tried to go through the doc its mostly in Chinese, can you please share if there is english version of it ?

Thanks !

[imbajin]

Hi, This is Sneha, I'm really interested work on this project Wiki: Graph Traversal Expansion () in GSoC'24, could anyone please let me know from where i can start ? I tried to go through the doc its mostly in Chinese, can you please share if there is english version of it ?

Thanks !

@snehanemadi Thanks for your attention. Most of the early sharing or studying notes/slides came from individuals, so there is no separate English version yet. Perhaps we need GPT* tools as a possible but not convenient conversion way... 😿

@liuxiaocs7 @VGalaxies any suggestion about it? 💡

And the task of GSOC can be discussed separately in another issue/discussion~ (if need)

[555vedant]

i would like to deal with this issue can you assign it to me ??

[imbajin]

i would like to deal with this issue can you assign it to me ??

@555vedant Thank you for your attention, but this is a summary issue. What task would you like to be assigned to you? You can find the corresponding issue from the task panel