Skip to content

Commit fd93ffe

Browse files
chore: Add a docs section about mise
1 parent ab0b509 commit fd93ffe

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -609,6 +609,32 @@ kurtosis service stop <enclave-name> <service-name>
609609
kurtosis service start <enclave-name> <service-name>
610610
```
611611

612+
## Development
613+
614+
### Development environment
615+
616+
We use [`mise`](https://mise.jdx.dev/) as a dependency manager for these tools.
617+
Once properly installed, `mise` will provide the correct versions for each tool. `mise` does not
618+
replace any other installations of these binaries and will only serve these binaries when you are
619+
working inside of the `optimism-package` directory.
620+
621+
#### Install `mise`
622+
623+
Install `mise` by following the instructions provided on the
624+
[Getting Started page](https://mise.jdx.dev/getting-started.html#_1-install-mise-cli).
625+
626+
#### Install dependencies
627+
628+
```sh
629+
mise install
630+
```
631+
632+
### Testing
633+
634+
We use [`BATS`](https://bats-core.readthedocs.io/en/stable/index.html), _Bash Automated Testing System_ to write tests for this repository.
635+
636+
`BATS` is installed as a git submodule so make sure to clone the repo with submodules if you want to run the test suite.
637+
612638
## Contributing
613639

614640
If you have made changes and would like to submit a PR, test locally and make sure to run `lint` on your changes

0 commit comments

Comments
 (0)