diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..5e22f3c --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @PetarStoev02 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e616e6b..4d3b094 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,6 +65,32 @@ Use conventional commits: - Link to the related issue if there is one - Make sure tests pass +## Local development + +```bash +git clone https://github.com/YOUR_USERNAME/cli.git +cd cli +npm install +``` + +### Run the dev build + +```bash +npm run dev +``` + +### Run tests + +```bash +npm test +``` + +### Run all CI checks locally + +```bash +npm run typecheck && npm run lint && npm run format:check && npm run build && npm test +``` + ## Related Repos - [@w3-kit/registry](https://github.com/w3-kit/registry) — Chain/token data diff --git a/README.md b/README.md index e98f852..8cdf073 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # w3-kit +[![CI](https://github.com/w3-kit/cli/actions/workflows/ci.yml/badge.svg)](https://github.com/w3-kit/cli/actions/workflows/ci.yml) +[![npm](https://img.shields.io/npm/v/w3-kit)](https://www.npmjs.com/package/w3-kit) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE) + CLI toolkit for web3 development. ## Install