Skip to content

Commit

Permalink
added section about benchmarks
Browse files Browse the repository at this point in the history
  • Loading branch information
i582 committed Jan 30, 2025
1 parent 74660cb commit 5e697f2
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions dev-docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,24 @@ Updating a subset of the test snapshots can be done like so:
yarn test -u spec-name-pattern1 spec-name-pattern2
```

## Benchmarks

The benchmarks system is used to track gas consumption changes after making changes to the compiler.

To run benchmarks:

```shell
yarn bench
```

### Adding a new benchmark

To add a new benchmark:

1. Add `*.tact` file to `src/test/benchmarks/contracts`
2. Recompile the benchmarks with `yarn gen:contracts:benchmarks`
3. Add additional benchmark to `src/test/benchmarks/benchmarks.spec.ts`

## Code quality

To pass review, code has to conform to our [styleguide](./STYLEGUIDE.md).
Expand Down

0 comments on commit 5e697f2

Please sign in to comment.