apache / incubator-hugegraph

A graph database that supports more than 100+ billion data, high performance and scalability (Include OLTP Engine & REST-API & Backends)
https://hugegraph.apache.org
Apache License 2.0
2.58k stars 512 forks source link

fix: update contribution doc to be more welcoming to new comers #2514

Open 0x2f2f2f2f opened 2 months ago

0x2f2f2f2f commented 2 months ago

Purpose of the PR

update documentation to be more similar to https://github.com/GreptimeTeam/greptimedb/contribute when it comes to first contributions to make it more welcoming for new contributers.

Main Changes

Modifying documentation to be easier for new comers to understand the codebase and better understand set up of repository.

Verifying these changes

Does this PR potentially affect the following parts?

Documentation Status

codecov-commenter commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 52.75%. Comparing base (1228dec) to head (f794390). Report is 1 commits behind head on master.

:exclamation: Current head f794390 differs from pull request most recent head 94d74bc. Consider uploading reports for the commit 94d74bc to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2514 +/- ## ============================================ - Coverage 61.03% 52.75% -8.28% + Complexity 827 488 -339 ============================================ Files 579 579 Lines 46232 46232 Branches 6275 6275 ============================================ - Hits 28219 24392 -3827 - Misses 15198 19275 +4077 + Partials 2815 2565 -250 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

imbajin commented 2 months ago

@imbajin Is it necessary to strictly enforce hard wrap (most diffs are caused by this)?

Currently nope (This is happening due to we lack the max-chars control for *.md files 😿 & IDEA used 100 for default)

But it's hard for new comer/devs to know the background, so the auto wrap occurred now.

Maybe we should update the config(max-length) in hugegraph-style.xml early?

VGalaxies commented 2 months ago

@imbajin Is it necessary to strictly enforce hard wrap (most diffs are caused by this)?

Currently nope (This is happening due to we lack the max-chars control for *.md files 😿 & IDEA used 100 for default)

But it's hard for new comer/devs to know the background, so the auto wrap occurred now.

Maybe we should update the config(max-length) in hugegraph-style.xml early?

@returnToInnocence could take a look here~

returnToInnocence commented 2 months ago

@returnToInnocence could take a look here~

https://github.com/apache/incubator-hugegraph/pull/2525 The problem of adapting the maximum length of markdown files can be solved with this pr

@0x2f2f2f2f u could update with the master branch & revert the markdown line break changes in this pr (restart IDEA if not work)