Contributing to Solidity-Coverage

Contributions are welcome! We appreciate your help in improving the tool. If you're opening a Pull Request that adds new features or options, please include comprehensive unit tests.

Development Setup

To set up your local development environment, follow these steps:

Clone the repository:

git clone https://github.com/sc-forks/solidity-coverage.git

Navigate to the project directory:
```
cd solidity-coverage
```
Install dependencies: The project uses yarn for dependency management.
```
yarn
```

Running Tests

The project has separate scripts for running unit and integration tests.

To run unit tests:
```
yarn test:unit
```
To run integration tests:
```
yarn test:integration
```
To run all tests (as done in CI):
```
yarn test:ci
```

Some tests can also be run with the viaIR compilation pipeline enabled by setting an environment variable:

Unit tests with viaIR:
```
yarn test:unit:viaIR
```
Integration tests with viaIR:
```
yarn test:integration:viaIR
```