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.

Sign up for GitHub

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

Proof-read git flow. #1244

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Proof-read git flow. #1244

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ A continuous integration server (CI) serializes and signs the updated seed file
- `/src` contains the web dashboard to browse the seed contents, the tracker code to track seed changes and the current seed generator. See [src/README.md](src/README.md) for details.
- `/studies` contains the studies used to generate the seed.

## Git flow for `/studies`

1. Run `npm install` after a checkout.
2. Create or modify a study in `/studies`, following the protobuf schema in
[`src/proto/study.proto`](/src/proto/study.proto).
3. Run `npm run seed_tools lint -- --fix` until there are no issues.
4. Create a PR to the `main` branch.
5. Verify that everything works as intended using the PR instructions.
## Git flow for `studies`

1. Run `npm install` after checking out the repository.
2. Create or modify a study file in `studies` directory, following the protobuf
schema in [`src/proto/study.proto`](/src/proto/study.proto).
3. Run `npm run seed_tools lint -- --fix` and address found issues.
4. Create a Pull Request targeting the `main` branch.
5. Follow the PR instructions to verify that everything works as intended.

## Key Generation and Exchange

Expand Down