Review Primers
Review Primers
Review primers are onboarding documents that aim to arm CodeGov code reviewers with the required knowledge to effectively review Internet Computer Protocol replica upgrades. The primers are split along the same axis as the categories that Dfinity assigns to code commits, which also aligns with the internal Dfinity team structure.
Review Categories
Resources
There are already many great resources that you can use to learn about the Internet Computer overall before diving deeper into one of the lower-level layers.
- Internetcomputer.org
- wiki.internetcomputer.org
- Internet Computer Whitepaper
- Internet Computer Interface Spec
- Dfinity YouTube channel
- Inside the Internet Computer - YouTube Playlist
- Git Codeowners: The Codeowners configuration assigns “ownership” of Dfinity teams to certain parts of the codebase. Since the team structure aligns with components of the stack and review categories, this is a useful resource for identifying which parts of the codebase are relevant for each category.
Common Technologies
Several technologies are used throughout many layers of the Internet Computer Protocol so it will be useful to understand them well, regardless of what review category you are taking part in.
Rust
Rust: Rust is the most widely used programming language in the IC’s codebase
- The Rust Book
- Rust by Example
- The Easy Rust Book
- Rust API Guidelines
- Mmapped: Designing error types in Rust
Tokio
Tokio is an async implementation and runtime for Rust commonly used throughout the Internet Computer Protocol.
Protobuf
Protobuf: Protobuf is a data interchange format commonly used throughout the IC
More useful resources for Protobuf: