docs: add reviewers guide #5664
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
ghpbot-tari-project
added
P-acks_required
sdbondi
previously approved these changes
Aug 25, 2023
There was a problem hiding this comment.
Great start!
Some additional ideas:
- overflowing integer conversions (my_u64 as u32, etc)
- bounds checking (copy_from_slice etc)
- attackers use resources without bounds (e.g. can they stream junk forever)
- unsafe code blocks
- zeroize private data (w/ things to look out for with stack memory)
| #### Tokio | ||
| Tokio has many useful channels, and it can be difficult to know what to look out for, so here are some things to keep in mind: | ||
| 1. When using `watch`: | ||
| 1. Watches can block if the reference returned from `borrow()` is held for a long time. Any call to `borrow()` should drop the reference as soon as possible. |
ghpbot-tari-project
removed
P-reviews_required
Co-authored-by: Stan Bondi <sdbondi@users.noreply.github.com>
Co-authored-by: Stan Bondi <sdbondi@users.noreply.github.com>
Co-authored-by: Stan Bondi <sdbondi@users.noreply.github.com>
SWvheerden
reviewed
Aug 25, 2023
ghpbot-tari-project
added
the
P-reviews_required
Co-authored-by: SW van Heerden <swvheerden@gmail.com>
Co-authored-by: Hansie Odendaal <39146854+hansieodendaal@users.noreply.github.com>
stringhandler
commented
Aug 29, 2023
stringhandler
commented
Aug 29, 2023
Co-authored-by: SW van Heerden <swvheerden@gmail.com>
Co-authored-by: SW van Heerden <swvheerden@gmail.com>
Co-authored-by: SW van Heerden <swvheerden@gmail.com>
stringhandler
commented
Sep 7, 2023
stringhandler
commented
Sep 7, 2023
stringhandler
commented
Sep 7, 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.
Description
Add a reviewer's guide for new contributors
Motivation and Context
To educate new developers and upskill them to be effective reviewers
Breaking Changes