doc: move dev instructions to a new dev guide #2783
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #2783 +/- ##
==========================================
+ Coverage 72.57% 72.63% +0.06%
==========================================
Files 701 701
Lines 91382 91496 +114
==========================================
+ Hits 66321 66461 +140
+ Misses 25061 25035 -26
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
|
IMO you may directly delete the content you moved from Contributing.md. I mean, this PR can integrate my PR (#2200). And after this PR is merged, I will close my PR. |
Add cross-references and connecting descriptions to both docs to ensure a smooth information navigation experience.
Sunt-ing
reviewed
May 25, 2022
skyzh
reviewed
May 25, 2022
Added descriptions of Kafka and ZooKeeper components/services. |
…ata/risingwave into heng-updates-may24
|
@skyzh All comments resolved. Please check and let me know if you have additional comments. Thanks! |
Enter-tainer
pushed a commit
that referenced
this pull request
May 26, 2022
* doc: move dev instructions to a new dev guide * doc: remove dev instructions from contributing.md Add cross-references and connecting descriptions to both docs to ensure a smooth information navigation experience. * doc: update cross-reference links * doc: fix a typo * Update developer-guide.md * Update CONTRIBUTING.md * doc: clarify about enabling and downloading a component * doc: bug fixes and additional info * doc: fix file names and links Co-authored-by: Ting Sun <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's changed and what's your intention?
In the existing CONTRIBUTING.md, the instructions about submitting PRs are mixed with the instructions about how to develop RisingWave, which, due to its size, warrants a separate document, hence this pull request. The instructions about how to test the code changes are also moved to the developer guide.
@skyzh Please review and let me know if you have any comments. Thanks!
Additional changes are needed on top of the draft PR submitted by Ting. @Sunt-ing : Please review the changes and make necessary adjustments. Thanks.
PLEASE DO NOT LEAVE THIS EMPTY !!!
Please explain IN DETAIL what the changes are in this PR and why they are needed:
Checklist
Refer to a related PR or issue link (optional)
#2198