Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain approval rights #42

Merged
merged 10 commits into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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$
bkchr marked this conversation as resolved.
Show resolved Hide resolved
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$
bkchr marked this conversation as resolved.
Show resolved Hide resolved
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 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](docs/github-on-chain-identity.md) for instructions.
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.
9 changes: 9 additions & 0 deletions docs/github-on-chain-identity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 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. The identity needs to be set on Polkadot. 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/decode/0x1c010407676974687562123c67697468756220757365726e616d653e0000000000000000). See the following image for an example:
andresilva marked this conversation as resolved.
Show resolved Hide resolved

![Add github name to the additional fields of the on-chain identity](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.
bkchr marked this conversation as resolved.
Show resolved Hide resolved
bkchr marked this conversation as resolved.
Show resolved Hide resolved

If you have other identity fields (`display`, `legal`, `email`, etc) already configured on-chain, you have to repeat them in this extrinsic (`None` values will override the existing information).
5 changes: 0 additions & 5 deletions relay/polkadot/README.adoc

This file was deleted.

Loading