> For the complete documentation index, see [llms.txt](https://docs.union.finance/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.union.finance/developers/governance.md).

# Governance

{% embed url="<https://github.com/unioncredit/union-v1-contracts>" %}

## Quickstart

Requirements:

* Node @14.x
* Python @3.x (for running Slither)

1. Clone the repo
2. Install dependencies

```
$ yarn install
```

## Testing

To run the entire test suite:

```
$ yarn test
```

To run the unit tests only:

```
$ yarn unitTest
```

To run the deployment script tests:

```
$ yarn deployTest
```

## Coverage

To run tests with coverage:

```
$ yarn coverage
```

## Deployment

To deploy to a supported network:

```
$ yarn deploy {network}
```

Check the deployed params:

```
$ yarn checkDeploy {network}
```