Skip to content

Commit 49714d6

Browse files
committed
Update instructions to submit a PR
1 parent 5e93ba5 commit 49714d6

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

src/README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,16 @@ The Quorum Key itself can be used by QuorumOS and enclave apps to encrypt and au
1212

1313
### Submitting a PR
1414

15-
Before a PR can be merged it must:
16-
17-
Be formatted
15+
Before a PR can be merged you must run:
1816

1917
```bash
20-
make lint
18+
make lint # apply standardized code formatting
19+
make test # run unit tests locally
2120
```
2221

23-
And pass all tests
24-
25-
```bash
26-
make test-all
27-
```
22+
All tests must pass.
2823

29-
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.
24+
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.
3025

3126
### View the docs
3227

0 commit comments

Comments
 (0)