Open 0x2f2f2f2f opened 2 months ago
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
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
@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 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 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)
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
Doc - TODO
Doc - Done
Doc - No Need