Setup Developer Environment
Prerequisites
Before you begin, ensure you have the following tools installed on your system:
Setup
-
Install Rust: Follow the official Rust installation guide to install the latest stable version of Rust.
-
Install Git: Follow the official Git installation guide to install Git on your system.
-
Install Make: Make is a build automation tool that simplifies the build process. You can install Make using your package manager:
-
Debian/Ubuntu:
sudo apt-get install make
-
Fedora:
sudo dnf install make
-
Arch Linux:
sudo pacman -S make
-
macOS:
brew install make
-
Windows:
You can install Make using the Chocolatey package manager:
choco install make
-
-
Install Docker: Docker is a containerization platform that allows you to package and run applications in isolated environments. Follow the official Docker installation guide to install Docker on your system.
-
Fork and setup the Contower repository on GitHub. As shown in the Forking documentation.
Linting and Formatting
To maintain code quality and consistency, use clippy
for linting and rustfmt
for formatting. Install these tools if you haven't already:
rustup component add clippy
rustup component add rustfmt
Getting Help
If you encounter issues that you can't resolve, feel free to reach out for help:
- Join our Discord for real-time support.
- Open an issue on the GitHub repository.
By following these steps, you should be well on your way to contributing effectively to Contower. Thank you for your contributions!