Skip to content

Commit

Permalink
fix: removed openzeppelin dependency, fixed dev dependencies, and upd…
Browse files Browse the repository at this point in the history
…ated the contributing markdown to be clearer (#1081)
  • Loading branch information
PatrickAlphaC authored Jun 3, 2024
1 parent dcc88f6 commit 944bcac
Show file tree
Hide file tree
Showing 3 changed files with 5,105 additions and 3,416 deletions.
20 changes: 13 additions & 7 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,24 @@ git clone https://github.com/<your-github-username>/hardhat-zksync.git
git checkout -b feature/description-of-your-feature
```

## Add dependencies

This repo works with the [pnpm](https://pnpm.io/) package manager. To install the dependencies, run the following command:

```bash
pnpm install
```

## Making Changes

- **Write your code.** Ensure your code is thoroughly tested and functions as expected. Clear, well-commented code is always appreciated.

- **Compile and test.** Before submitting a pull request, ensure your code compiles, passes lint checks, and all tests are successful. You should also write unit tests for your contributions. Use the following command for these checks:

```bash
yarn lint
yarn test
yarn build
pnpm lint
pnpm test
pnpm build
```

- **Commit your changes.** Adhere to the [Conventional Commits](https://www.conventionalcommits.org/) standard when writing commit messages.
Expand All @@ -53,8 +61,8 @@ git push origin feature/description-of-your-feature
We follow basic coding style guidelines. Before committing, ensure your code is formatted and lint checks pass:

```bash
yarn lint
yarn lint:fix
pnpm lint
pnpm lint:fix
```

This ensures consistent code style throughout the project and helps identify potential issues early.
Expand All @@ -70,5 +78,3 @@ Once your PR is approved and merged, your contribution will be integrated into t
Remember, the best contributions come from enjoying the process, being respectful, and continuously learning. Thanks for being a part of our community!

---

*Last updated: November 29, 2023*
23 changes: 12 additions & 11 deletions packages/hardhat-zksync-verify/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,27 +33,29 @@
"README.md"
],
"dependencies": {
"@ethersproject/abi": "^5.1.2",
"@ethersproject/address": "5.7.0",
"@matterlabs/hardhat-zksync-solc": "^1.1.4",
"@nomicfoundation/hardhat-verify": "^2.0.0",
"axios": "^1.6.2",
"cbor": "^8.1.0",
"chai": "^4.3.6",
"hardhat": "^2.19.4",
"chalk": "4.1.2",
"@ethersproject/abi": "^5.1.2",
"@ethersproject/address": "5.7.0",
"cbor": "^8.1.0",
"debug": "^4.1.1",
"@openzeppelin/contracts": "^4.9.2",
"sinon-chai": "^3.7.0",
"sinon": "^17.0.1"
"hardhat": "^2.19.4",
"sinon": "^17.0.1",
"sinon-chai": "^3.7.0"
},
"devDependencies": {
"@nomicfoundation/hardhat-verify": "^2.0.0",
"@types/chai": "^4.2.0",
"@types/debug": "^4.1.12",
"@types/mocha": "^9.1.0",
"@types/node": "^18.11.17",
"@types/sinon": "^17.0.3",
"@typescript-eslint/eslint-plugin": "6.13.1",
"@typescript-eslint/parser": "6.13.1",
"@typescript-eslint/parser": "^7.10.0",
"c8": "^8.0.1",
"eslint": "^8.54.0",
"eslint-config-prettier": "9.0.0",
"eslint-plugin-import": "2.29.0",
Expand All @@ -63,8 +65,7 @@
"prettier": "3.1.0",
"rimraf": "^3.0.2",
"ts-node": "^10.6.0",
"typescript": "^5.1.6",
"c8": "^8.0.1"
"typescript": "^5.1.6"
},
"peerDependencies": {
"@nomicfoundation/hardhat-verify": "^2.0.0"
Expand All @@ -76,4 +77,4 @@
"singleQuote": true,
"bracketSpacing": true
}
}
}
Loading

0 comments on commit 944bcac

Please sign in to comment.