Skip to content

Commit

Permalink
Update instructions to submit a PR
Browse files Browse the repository at this point in the history
  • Loading branch information
r-n-o committed Nov 11, 2024
1 parent 5e93ba5 commit 49714d6
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,16 @@ The Quorum Key itself can be used by QuorumOS and enclave apps to encrypt and au

### Submitting a PR

Before a PR can be merged it must:

Be formatted
Before a PR can be merged you must run:

```bash
make lint
make lint # apply standardized code formatting
make test # run unit tests locally
```

And pass all tests

```bash
make test-all
```
All tests must pass.

The PR will also need to pass the `build-linux-only-crates` github workflow. There are 3 crates excluded from the rust workspace: `qos_system`, `qos_aws`, and `init`. These crates are excluded because they only build on linux. If you are not working directly with these crates they generally only need to be updated if the dependencies for `qos_core` change. The linux only crates each have their own lockfile and that will need to be up to date for deterministic builds to work. To update the locks files you will need a linux build environment. Once in a linux build enviroment you can run `make build-linux-only`, which will update lock files if neccesary; any updated lock files should then be committed.
The PR will also need to pass the `build-linux-only` github workflow. There are 3 crates excluded from the Rust workspace: `qos_system`, `qos_aws`, and `init`. These crates are excluded because they only build on Linux. If you are not working directly with these crates they generally only need to be updated if the dependencies for `qos_core` change. The linux only crates each have their own lockfile and that will need to be up to date for deterministic builds to work. To update the locks files you will need a linux build environment. Once in a linux build environment you can run `make build-linux-only`, which will update lock files if necessary; any updated lock files should then be committed.

### View the docs

Expand Down

0 comments on commit 49714d6

Please sign in to comment.