Skip to content

Commit

Permalink
small edit
Browse files Browse the repository at this point in the history
  • Loading branch information
alecps committed Dec 7, 2023
1 parent bba2cb9 commit e61ff12
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,12 @@ See the [community contribution guide](https://docs.celo.org/community/contribut

## Directory Structure


<pre>
├── <a href="./docs">docs</a>: Documentation on how SocialConnect works and how to use it
├── <a href="./kubernetes-deployments">kubernetes-deployments</a>: YAML config files and instructions for ODIS deployment
├── <a href="./odis">odis</a>: Decentralized Identifier Service for SocialConnect
│ ├── <a href="./odis/combiner">combiner</a>: Orchestrates distributed BLS threshold signing with the set of ODIS signers - requests and combines partial signatures.
│ ├── <a href="./odis/monitor">monitor</a>: Monitoriing service that sends health checks to deployed ODIS instances. Also contains code for load testing.
│ ├── <a href="./odis/combiner">combiner</a>: Orchestrates distributed BLS threshold signing with the set of ODIS signers - requests and combines partial signatures.
│ ├── <a href="./odis/monitor">monitor</a>: Monitoriing service that sends health checks to deployed ODIS instances. Also contains code for load testing.
│ ├── <a href="./odis/signer">signer</a>: Generates unique partial signatures for blinded messages
├── <a href="./packages">packages</a>: TODO(how to describe this)
│ ├── <a href="./packages/common">common</a>: Contains common logic for ODIS
Expand Down Expand Up @@ -86,11 +85,14 @@ TODO (doesn't currently work for odis)
yarn test
```

ODIS also has e2e tests that can be run from within `./odis/*` directories by running
ODIS also has e2e tests that can be run from within `./odis/*` directories by running

```bash
cd odis/signer
yarn test:e2e
````
or specify the environment (see package.json)

or specify the environment (see package.json)

```bash
yarn test:e2e:mainnet
Expand All @@ -100,4 +102,4 @@ For load tests, checkout [odis/monitor](../odis/monitor/README.md)

#### PRs and Releases

See [Release.md](../RELEASE.md) and [kubernetes-deployment](/kubernetes-deployment)
See [Release.md](../RELEASE.md) and [kubernetes-deployment](/kubernetes-deployment)

0 comments on commit e61ff12

Please sign in to comment.