-
Notifications
You must be signed in to change notification settings - Fork 521
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: update contribution doc to be more welcoming to new comers #2514
base: master
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@imbajin Is it necessary to strictly enforce hard wrap (most diffs are caused by this)?
|
||
[![contributors graph](https://contrib.rocks/image?repo=apache/hugegraph)](https://github.com/apache/incubator-hugegraph/graphs/contributors) | ||
Pull Requests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alone on its own line?
Currently nope (This is happening due to we lack the max-chars control for 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 |
@returnToInnocence could take a look here~ |
#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