Repository files navigation

If you want to get an example node running quickly you can execute the following getting started script:

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/scripts/getting-started.sh | bash

• Polkadot Documentation Portal
• 🦀 rust-docs: Where we keep track ofthe API docs of our Rust crates. Includes:
  • Introductionto each component of the Polkadot SDK: Substrate, FRAME, Cumulus, and XCM
  • Guides,namely how to build your first FRAME pallet
  • Templatesfor starting a new project.
  • External Resources

The Polkadot SDK is released every three months as astableYYMM release. They are supported forone year with patches. See the next upcoming versions in theReleaseRegistry and more docs inRELEASE.md.

You can usepsvm to update all dependencies to a specificversion without needing to manually select the correct version for each crate.

Polkadot SDK Version Manager:A simple tool to manage and update the Polkadot SDK dependencies in any Cargo.toml file.It will automatically update the Polkadot SDK dependencies to their correct crates.io version.

The security policy and procedures can be found indocs/contributor/SECURITY.md.

Ensure you follow ourcontribution guidelines. In everyinteraction and contribution, this project adheres to theContributor Covenant Code ofConduct.

Take a look at the issues labeled withmentor(or alternativelythis page, created by one of the maintainers) label to get started!We always recognize valuable contributions by proposing an on-chain tip to the Polkadot network as a token of ourappreciation.

Development in this repo usually goes hand in hand with thefellowship organization. In short,this repository provides all the SDK pieces needed to build both Polkadot and its parachains. But,the actual Polkadot runtime lives in thefellowship/runtimes repository. Read more about thefellowship, this separation, the RFC processhere.

This repository is the amalgamation of 3 separate repositories that used to make up Polkadot SDK,namely Substrate, Polkadot and Cumulus. Read more about the merge and its historyhere.