Make Contributing guide more newbie friendly #5537
Merged
Conversation
This file contains 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
* Add links to fundamental testing concepts in Rust * Add information about conditional compilation attributes and how to use them to run tests with cargo
satakuma
added
the
A-readme
Darksonn
reviewed
Mar 11, 2023
Co-authored-by: Alice Ryhl <aliceryhl@google.com>
taiki-e
reviewed
Mar 11, 2023
Co-authored-by: Taiki Endo <te316e89@gmail.com>
satakuma
reviewed
Mar 12, 2023
There was a problem hiding this comment.
Thanks for the PR. I left some minor comments inline. Could you please wrap all lines to 80 characters to match the formatting style used in this document? You can use reference-style links to deal with long URLs.
Co-authored-by: Tymoteusz Wiśniewski <tymo@tymo.xyz>
Co-authored-by: Tymoteusz Wiśniewski <tymo@tymo.xyz>
|
Thanks for all the feedback and suggestions so far! |
satakuma
reviewed
Mar 12, 2023
Co-authored-by: Tymoteusz Wiśniewski <tymo@tymo.xyz>
satakuma
approved these changes
Mar 12, 2023
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.
Motivation
One of the first things a new contributor will want to do, is to execute the tests for the project. We can make tokio more accessible to newbies, by making running tests as simple as possible.
Solution
This PR amends the existing Contributing guide, by adding links to fundamental testing concepts in Rust, and information about conditional compilation attributes and how to use them to run tests with cargo.