Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 4.97 KB

README.md

File metadata and controls

88 lines (60 loc) · 4.97 KB
Raw

Runtimes

This repository houses the code required to build the runtimes for Polkadot, Kusama, and their System-Parachains. Its maintenance is overseen by the Fellowship, as decreed by the Polkadot and Kusama Governance. The primary objective is to provide excellent code, which can subsequently be enacted on-chain through a decentralized referendum.

Structure

Each leaf folder contains one runtime crate:

├── relay
│   ├── kusama
│   └── polkadot
└── system-parachains
    ├── asset-hubs
    │   ├── asset-hub-kusama
    │   └── asset-hub-polkadot
    ├── bridge-hubs
    │   ├── bridge-hub-kusama
    │   └── bridge-hub-polkadot
    ├── collectives
    │   └── collectives-polkadot
    └── gluttons
        └── glutton-kusama

Approval rights

The approval rights are configured in review-bot.yml. The rights are configured as:

  • All files in .github require two approvals from Fellowship members of rank 4 or higher.
  • CHANGELOG.md, relay/* or system-parachains/* require four approvals from Fellowship members of rank 3 or higher.
  • All other files require the approval from one Fellowship member of rank 2 or higher.

The review-bot uses the on-chain identity to map from a GitHub account to a Fellowship member. This requires that each Fellowship member add their GitHub handle to their on-chain identity. Check here for instructions.

Working on Pull Requests

To merge a pull request, we use Auto Merge Bot.

To use it, write a comment in a PR that says:

/merge

This will enable auto-merge in the Pull Request (or merge it if it is ready to merge).

The automation can be triggered by the author of the PR or any fellow whose GitHub handle is part of their identity.

Release process

Releases are automatically pushed on commits merged to master that fulfill the following requirements:

  • The CHANGELOG.md file was modified.
  • The latest version (the version at the top of the file) in CHANGELOG.md has no tag in the repository.

The release process is building all runtimes and then puts them into a release in this github repository.

The format of CHANGELOG.md is based on Keep a Changelog.

Release guidelines

Here is an overview of the recommended steps.

Steps Description
0 Open an issue for the release in the runtimes repo with the version number.
1 Update polkadot-sdk, if applicable.
2 Identify and monitor potential blockers (old dependencies, pending or failed upgrades).
3 Identify and include PRs with required tests, highlighting the integration tests that have changed.
4 Identify and communicate all details about potential breaking changes (transaction/event/error encoding, polkadot-sdk migrations, XCM and storage format, etc.) or disruptions. Make sure to ping @SBalaguer and @anaelleltd in your commentary.
5 Run benchmarking for changed pallets.
6 Trigger the release for final reviews, making sure to highlight information about all breaking changes or disruptions in the CHANGELOG entry.
7 Create the whitelisting proposal (Fellowship) with contextual information.
8 Create the whitelisted caller referendum (OpenGov) with contextual information and instructions for following up on breaking changes or disruptions.
9 Close the issue for the release once the referendum is approved and executed.
10 Open an issue for the next release in the runtimes repo, if applicable.

Communication channels

The Fellowship is using Matrix for communication. Right now there exists two channels: