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

docs: add submodule update instructions #190

Merged
merged 1 commit into from
Jan 27, 2023
Merged

docs: add submodule update instructions #190

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
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,12 @@ Clone the repo and make sure to include the submodules by adding `--recurse-subm
git clone --recurse-submodules https://github.com/runfinch/finch.git
```

If the repo is already cloned, but the submodules are not pulled yet, the following command can be run to pull all of the submodules without re-cloning:

```shell
git submodule update --init --recursive
```

After cloning the repo, run `make` to build the binary.

The binary in `_output` can be directly used. E.g. initializing the vm and display the version
Expand Down Expand Up @@ -215,7 +221,7 @@ before you submit your code:

#### Unit Testing - Parallel by Default

```make test-unit```
`make test-unit`

For each unit test case (i.e., in both `TestXXX` and the function passed to `t.Run`), `t.Parallel` should be added by default. It should only be skipped under special situations (e.g., `T.Setenv` is used in that test).

Expand All @@ -230,7 +236,7 @@ Keeping a good unit test coverage will be part of pull request review. You can r

#### E2E Testing Guidelines

```make test-e2e```
`make test-e2e`

See `test-e2e` section in [`Makefile`](./Makefile) for more reference.

Expand Down