incubator-hugegraph icon indicating copy to clipboard operation
incubator-hugegraph copied to clipboard

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

Open 0x2f2f2f2f opened this issue 1 year ago • 4 comments

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

  • [x] Trivial rework / code cleanup without any test coverage. (No Need)
  • [ ] Already covered by existing tests, such as (please modify tests here).
  • [ ] Need tests and can be verified as follows:
    • xxx

Does this PR potentially affect the following parts?

  • [ ] Dependencies (add/update license info & regenerate_dependencies)
  • [ ] Modify configurations
  • [ ] The public API
  • [ ] Other affects (typed here)
  • [x] Nope

Documentation Status

  • [ ] Doc - TODO
  • [ ] Doc - Done
  • [ ] Doc - No Need

0x2f2f2f2f avatar Apr 09 '24 14:04 0x2f2f2f2f

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
@@             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.

codecov-commenter avatar Apr 12 '24 09:04 codecov-commenter

@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?

imbajin avatar Apr 15 '24 05:04 imbajin

@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~

VGalaxies avatar Apr 15 '24 06:04 VGalaxies

@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)

returnToInnocence avatar Apr 16 '24 12:04 returnToInnocence