Skip to content

Commit

Permalink
feat: rewrite “Validate your changes” grouping by source type rather …
Browse files Browse the repository at this point in the history
…than check type
  • Loading branch information
marcalexiei committed Feb 20, 2025
1 parent ed34aec commit 840c6ca
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 17 deletions.
41 changes: 25 additions & 16 deletions src/routes/documentation/contributing/local-development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -164,46 +164,55 @@ The following checks are all run on pull requests automatically.

You can also perform them locally.

## Formatting
### Rust

For the typescript part you can run:
Ensure that all code follows the style guidelines:

```sh
pnpm run format:check && pnpm run -w repo:root:format:check
cargo fmt
```

For the rust codebase run:
Check that no linting errors/warnings are present:

```sh
cargo fmt
cargo clippy -- -D warnings
```

### Linting

For the typescript part you can run:
Tests:

```sh
pnpm run lint
cargo test
```

For the rust codebase run:
### Typescript

TypeScript checks are composed of the following:

- `build`
- `format`
- `lint`
- `typecheck`
- `test`

You can run them singularly using `pnpm run CHECK` or by using the `check-all` script:

```sh
cargo clippy -- -D warnings
pnpm run check-all
```

### Tests
### E2E Tests

For the typescript part you can run:
To execute end-to-end tests, we are using [playwright](https://playwright.dev).
To install the required browsers, run:

```sh
pnpm run test
pnpm exec playwright install
```

For the rust codebase run:
Then, you can run the tests with:

```sh
cargo test
pnpm run test:e2e
```

import NavigationButtons from '../../../components/NavigationButtons'
Expand Down
2 changes: 1 addition & 1 deletion src/routes/documentation/contributing/pull-requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ you can check the [official documentation](https://docs.github.com/en/pull-reque
- If you are adding a new feature, describe the intended use case that the feature fulfills.

- Ensure your code is valid by running the test on you local machine.
Refer to ["Validate your changes" section](/documentation/contributing/local-development)
Refer to ["Validate your changes" section](/documentation/contributing/local-development#validate-your-changes)

- Please **don't**:

Expand Down

0 comments on commit 840c6ca

Please sign in to comment.