Introduction
Hello and welcome to the rsh Contributor Book. rsh, or Rsh as its often called, is a modern shell written in Rust. You can learn more about Rsh and how to use it in the Rsh book. In this book, we'll be looking at how to contribute to the Rsh project itself, how Rsh's code is organized, and the core concepts behind its design.
Contributing to Rsh will require at least some basic programmer experience, and it's helpful to have some experience with Rust. That said, we've had people contribute to Rsh who have never written a line of Rust before writing their submission. If you are interested in contributing, there's a growing community of people who would like to help you succeed.
This aims to cover three separate areas:
- The Design Philosophy of Rsh
- The Implementation of Rsh
- Best practices for coding for Rsh
The latter two topics are primarily covered directly in the
rsh repository
in developer documentation crossreferenced from its
CONTRIBUTING.md file.