List of enhancements - Githubissues

DeFiFoFum / hardhat-template

Solidity Smart Contract development template using modern Web3 frameworks/tools including Hardhat, Typechain and more.

GNU General Public License v3.0

1 stars 3 forks source link

List of enhancements #3

Open DeFiFoFum opened 2 years ago

DeFiFoFum commented 2 years ago

Config improvements

[x] Setup tsconfig.json so that a build will output contract artifacts and types
[x] Add scripts to enforce styling on commits (Added linting to GitHub actions)
[x] Add hardhat features to the features list below?

Contract improvements

[x] Add information about OpenZeppelin contracts
[x] Add a document generator from natspec comments
[ ] natspec: find a tool which preloads the parameter details for natspec comments
[ ] Consider adding Sourcify as the go to contract verification tool

Test improvements

[ ] Network helpers? https://hardhat.org/hardhat-network-helpers/docs/reference
[x] Create a test-helper library to deploy a mock-dex and mock-farm: https://github.com/ApeSwapFinance/apeswap-hardhat-test-helpers
[x] Coverage reporting