Skip to content

Commit

Permalink
Explain approval rights
Browse files Browse the repository at this point in the history
This also adds a tutorial on how to add the github name to the on-chain identity.
  • Loading branch information
bkchr committed Sep 25, 2023
1 parent ca29673 commit 9a2e88f
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 15 deletions.
16 changes: 6 additions & 10 deletions .github/review-bot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,20 @@ rules:
- name: Relay and system files
condition:
include:
- ^relay\/kusama\/.*
- ^relay\/polkadot\/.*
- ^relay\/.*
- ^system-parachains\/.*
- ^CHANGELOG$
exclude:
- ^relay\/.+\.adoc$
- ^CHANGELOG.md$
type: fellows
minRank: 3
minApprovals: 4
- name: General Files
condition:
include:
- '.*'
exclude:
- ^relay\/kusama\/.*
- ^relay\/polkadot\/.*
- ^\.github/.*
exclude:
- ^relay\/.*
- ^system-parachains\/.*
- ^target\/.*
- ^\.github/.*
- ^CHANGELOG.md$
type: fellows
minRank: 2
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,13 @@ Do not modify the `relay/` or `system-parachains/` folder. They are currently re
└── collectives
└── collectives-polkadot
```

## Approval rights

The approval rights are configured in [`review-bot.yml`](.github/review-bot.yml). The rights are configured as:

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

The review-bot is using the on chain identity to map from a github account to a fellowship member. This requires that each fellowship member adds its github handle to its on-chain identity. Check [here](docs/github-on-chain-identity.md) for an instruction.
Binary file added docs/github-on-chain-identity-process.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/github-on-chain-identity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Adding github account to your on-chain identity

Adding the github account to your identity requires the usage of the `additional` fields in the identity info. This is currently only supported by using the [polkadot-js bare extrinsic interface](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frpc.polkadot.io#/extrinsics). See the following image for an example:

![][github-on-chain-identity-process.jpg]

You should also at least add the `display` field. If you want to add `utf8` characters, you need to hex encode them and put the hex string (`0x` prefixed) into the field.
5 changes: 0 additions & 5 deletions relay/polkadot/README.adoc

This file was deleted.

0 comments on commit 9a2e88f

Please sign in to comment.