Skip to content

docs: add quick start in readme, rewrite contributing guide #1395

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.

Sign up for GitHub

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

Jump to bottom
Merged
skyzh merged 1 commit into from
Mar 30, 2022
Merged

docs: add quick start in readme, rewrite contributing guide #1395

skyzh merged 1 commit into from
Mar 30, 2022

Conversation

@skyzh
Copy link
Contributor

@skyzh skyzh commented Mar 30, 2022

Signed-off-by: Alex Chi [email protected]

What's changed and what's your intention?

The readme is quite not organized. I think we will need some experienced writers to re-arrange the readme.

In this PR, we added a quick start guide.

Checklist

  • I have written necessary docs and comments
  • I have added necessary unit tests and integration tests

Refer to a related PR or issue link (optional)

@skyzh skyzh requested a review from fuyufjh March 30, 2022 03:47
@github-actions github-actions bot added the A-doc Area: Documentation. label Mar 30, 2022
@skyzh
Copy link
Contributor Author

skyzh commented Mar 30, 2022

We can move most of the contents in README to CONTRIBUTING.md. I think no one would care about the development process at first glance...

@codecov
Copy link

codecov bot commented Mar 30, 2022 •
edited
Loading

Codecov Report

Merging #1395 (4fed7ac) into main (0d6bf8e) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #1395      +/-   ##
============================================
- Coverage     70.14%   70.14%   -0.01%     
  Complexity     2766     2766              
============================================
  Files          1027     1027              
  Lines         89649    89658       +9     
  Branches       1790     1790              
============================================
+ Hits          62885    62890       +5     
- Misses        25873    25877       +4     
  Partials        891      891
Flag Coverage Δ
java 61.01% <ø> (ø)
rust 72.10% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
rust/storage/src/hummock/mod.rs 63.84% <0.00%> (-3.34%) ⬇️
rust/stream/src/task/barrier_manager.rs 57.00% <0.00%> (-0.58%) ⬇️
rust/meta/src/barrier/mod.rs 70.85% <0.00%> (-0.52%) ⬇️
rust/connector/src/filesystem/file_common.rs 80.71% <0.00%> (-0.45%) ⬇️
rust/storage/src/memory.rs 69.84% <0.00%> (ø)
rust/storage/src/tikv_mock.rs 0.00% <0.00%> (ø)
rust/storage/src/panic_store.rs 0.00% <0.00%> (ø)
rust/storage/src/rocksdb_local_mock.rs 0.00% <0.00%> (ø)
rust/meta/src/rpc/service/stream_service.rs 0.00% <0.00%> (ø)
rust/storage/src/monitor/monitored_store.rs 2.35% <0.00%> (ø)
... and 2 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@skyzh skyzh removed the request for review from fuyufjh March 30, 2022 03:56
@skyzh skyzh marked this pull request as draft March 30, 2022 03:56
@skyzh skyzh force-pushed the skyzh/update-readme branch from b1eeab4 to 4fed7ac Compare March 30, 2022 04:30
@skyzh skyzh marked this pull request as ready for review March 30, 2022 04:30
@skyzh skyzh changed the title docs: add quick start in readme docs: add quick start in readme, rewrite contributing guide Mar 30, 2022
@skyzh skyzh requested a review from fuyufjh March 30, 2022 04:30
fuyufjh
fuyufjh approved these changes Mar 30, 2022
View reviewed changes
Copy link
Collaborator

@fuyufjh fuyufjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks gooooood to me!!

@skyzh skyzh merged commit 38795d8 into main Mar 30, 2022
@skyzh skyzh deleted the skyzh/update-readme branch March 30, 2022 04:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fuyufjh fuyufjh fuyufjh approved these changes

Assignees

No one assigned

Labels

A-doc Area: Documentation.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@skyzh @fuyufjh