Bitgreen primarily uses GitHub Pull Requests to coordinate code changes. If you wish to propose a contribution, open a pull request and review the template, which explains how to document your proposal.
Bitgreen is following the Substrate code style.
In addition, we incorporate several tools to improve code quality. These are integrated into our CI and are expected to pass before a PR is considered mergeable. They can also be run locally.
- clippy - run with
cargo clippy --release --workspace - rustfmt - run with
cargo fmt -- --check - prettier - run with
npx prettier --check --ignore-path .gitignore '**/*.(yml|js|ts|json)'(runs againsttypescriptcode)
The following is a list of directories of interest in development.
| Directory | Purpose |
|---|---|
| client/ | Debug & Trace related code (rust) |
| docker/ | Dockerfiles for running Bitgreen |
| parachain/ | Bitgreen's main node (rust) |
| pallets/ | Bitgreen's Substrate runtime pallets (rust) |
| primitives/ | Base types used in runtime |
| runtime/ | Bitgreen's runtime (on-chain) code (rust, compiled to WASM) |
| scripts/ | Utilities for launching and interacting with a Bitgreen chain (typescript) |
| tools/ | Various tools generally related to development (typescript) |
Any PR must indicate whether the changes should be part of the runtime changelog or the binary changelog or neither.
If the changes are to be listed in the runtime changelog, associate the label B7-runtimenoteworthy with your PR.
If the changes should be listed in the binary changelog, associate the label B5-clientnoteworthy with your PR.
If the changes are not to be listed in any changelog, associate the label B0-silent with your PR.
For branch conventions related to this git repository, see Git branch conventions.