![SDK Logo](./docs/images/Polkadot_Logo_Horizontal_Pink_White.png#gh-dark-mode-only) ![SDK Logo](./docs/images/Polkadot_Logo_Horizontal_Pink_Black.png#gh-light-mode-only) # Polkadot SDK ![GitHub stars](https://img.shields.io/github/stars/paritytech/polkadot-sdk) ![GitHub forks](https://img.shields.io/github/forks/paritytech/polkadot-sdk) [![StackExchange](https://img.shields.io/badge/StackExchange-Community%20&%20Support-222222?logo=stackexchange)](https://substrate.stackexchange.com/) ![GitHub contributors](https://img.shields.io/github/contributors/paritytech/polkadot-sdk) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/paritytech/polkadot-sdk) ![GitHub last commit](https://img.shields.io/github/last-commit/paritytech/polkadot-sdk) > The Polkadot SDK repository provides all the components needed to start building on the > [Polkadot](https://polkadot.network) network, a multi-chain blockchain platform that enables > different blockchains to interoperate and share information in a secure and scalable way.

## ⚡ Quickstart 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 ``` ## 📚 Documentation * [🦀 rust-docs](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html) * [Introduction](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/index.html) to each component of the Polkadot SDK: Substrate, FRAME, Cumulus, and XCM * [Guides](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/guides/index.html), namely how to build your first FRAME pallet. * [Templates](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/templates/index.html) for starting a new project. * Other Resources: * [Polkadot Wiki -> Build](https://wiki.polkadot.network/docs/build-guide) ## 🚀 Releases > [!NOTE] > Our release process is still Work-In-Progress and may not yet reflect the aspired outline > here. The Polkadot-SDK has two release channels: `stable` and `nightly`. Production software is advised to only use `stable`. `nightly` is meant for tinkerers to try out the latest features. The detailed release process is described in [RELEASE.md](docs/RELEASE.md). You can use [`psvm`](https://github.com/paritytech/psvm) to manage your Polkadot-SDK dependency versions in downstream projects. ### 😌 Stable `stable` releases have a support duration of **three months**. In this period, the release will not have any breaking changes. It will receive bug fixes, security fixes, performance fixes and new non-breaking features on a **two week** cadence. ### 🤠 Nightly `nightly` releases are released every night from the `master` branch, potentially with breaking changes. They have pre-release version numbers in the format `major.0.0-nightlyYYMMDD`. ## 🛠️ Tooling [Polkadot SDK Version Manager](https://github.com/paritytech/psvm): 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. ## 🔐 Security The security policy and procedures can be found in [docs/contributor/SECURITY.md](./docs/contributor/SECURITY.md). ## 🤍 Contributing & Code of Conduct Ensure you follow our [contribution guidelines](./docs/contributor/CONTRIBUTING.md). In every interaction and contribution, this project adheres to the [Contributor Covenant Code of Conduct](./docs/contributor/CODE_OF_CONDUCT.md). ### 👾 Ready to Contribute? Take a look at the issues labeled with [`mentor`](https://github.com/paritytech/polkadot-sdk/labels/C1-mentor) (or alternatively [this](https://mentor.tasty.limo/) 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 our appreciation. ## Polkadot Fellowship Development in this repo usually goes hand in hand with the `fellowship` 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 the `fellowship/runtimes` repository. Read more about the fellowship, this separation, the RFC process [here](https://polkadot-fellows.github.io/dashboard/). ## History 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 history [here](https://polkadot-public.notion.site/Polkadot-SDK-FAQ-fbc4cecc2c46443fb37b9eeec2f0d85f).