Getting Started

Environment setup

Follow the instructions below to set up your development environment for Substrate.

Substrate Core

1. Install Rust. Make sure you have at least version 1.70.0.
2. Install just by running cargo install just.
3. Enable git commit signing.
4. Fork the substrate2 repository.
5. Clone your fork.
6. From the root of your cloned substrate2 repo, run just check and just test. Ensure these commands complete with no errors.

Documentation

1. Install NodeJS. We recommend using a version manager like nvm.
2. Install yarn.
3. Change into the docs/substrate directory inside your cloned substrate2 repo.
4. Run yarn install.
5. Run yarn start. Ensure that the documentation website opens in your browser and that there are no errors logged.

Contributing guidelines

• Within-repository Rust dependencies should specify both a path and a version number.
• Commit messages should follow conventional commits. The body of the commit message should describe the changes that were made. These messages will be aggregated into CHANGELOGs.
• The first line of commit messages should be kept to less than 50 characters where possible.
• Each line in the commit body should be kept to 80 characters or less.
• All contributions should be submitted by opening a PR against this repository. If you do not have direct access to this repo, you should create a fork, make changes on your fork, and then submit your changes as a PR.
• After merging PRs, delete the branch.