Skip to content

Commit

Permalink
Add edits to CONTRIBUTING.md (#2433)
Browse files Browse the repository at this point in the history
  • Loading branch information
gememma authored May 8, 2024
1 parent c2b5069 commit 9b9ec7d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ The following guide details the steps to setup a local development environment f

### Prerequisites

- [GCC](https://gcc.gnu.org/) - only on Linux, GCC is needed for Go dynamic linking
- [Rust](https://www.rust-lang.org/)
- [NodeJS](https://nodejs.org/en/), [ExpressJS](https://expressjs.com/)
- [Python](https://www.python.org/), [Flask](https://flask.palletsprojects.com/en/2.1.x/), [FastAPI](https://fastapi.tiangolo.com/)
Expand Down Expand Up @@ -109,6 +110,8 @@ If new tests are added, decorate them with `cfg_attr` attribute macro to define
For example, a test which only tests sanity of the ephemeral container feature should be decorated with
`#[cfg_attr(not(feature = "ephemeral"), ignore)]`

On Linux, running tests may exhaust a large amount of RAM and crash the machine. To prevent this, limit the number of concurrent jobs by running the command with e.g. `-j 4`

### Cleanup

The Kubernetes resources created by the E2E tests are automatically deleted when the test exits. However, you can preserve resources from failed tests for debugging. To do this, set the `MIRRORD_E2E_PRESERVE_FAILED` variable to any value.
Expand Down Expand Up @@ -394,7 +397,7 @@ Debugging mirrord can get hard since we're running from another app flow, so the
The recommended way to do it is to use `mirrord-console`. It is a small application that receives log information from different mirrord instances and prints it, controlled via `RUST_LOG` environment variable.

To use mirrord console, run it:
`cargo run --bin mirrord-console`
`cargo run --bin mirrord-console --features binary`

Then run mirrord with the environment variable:
`MIRRORD_CONSOLE_ADDR=127.0.0.1:11233`
Expand Down
1 change: 1 addition & 0 deletions changelog.d/+contributing-guide-updated.changed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update contributing guide.

0 comments on commit 9b9ec7d

Please sign in to comment.