Consensys / sol-dbg

Solidity source debugger built around EthereumJS
Apache License 2.0
21 stars 3 forks source link

Housekeeping #2

Closed cd1m0 closed 2 years ago

cd1m0 commented 2 years ago

Several house-keeping items:

  1. [x] Fill out the readme
  2. [x] Add coverage info
  3. [x] Add CI
  4. [x] Add badges
  5. [x] Publish package
blitz-1306 commented 2 years ago

Added CI via GitHub actions in commit https://github.com/ConsenSys/sol-dbg/commit/047e0dd952931e8204be7a3d2c2921a3604d211d. It is configurable via https://github.com/ConsenSys/sol-dbg/blob/main/.github/workflows/node.js.yml.

blitz-1306 commented 2 years ago

By publishing it, do you also mean open sourcing?

blitz-1306 commented 2 years ago

Should license be an Apache 2.0 like we use in other ConsenSys repos? Or keep it GPL 3.0 as it currently is?

blitz-1306 commented 2 years ago

Added few badges in https://github.com/ConsenSys/sol-dbg/commit/3fef9201edd71643938a18cada122ab39ef18777. Coverage and NPM badges would be added when package will be attached to CodeCov and published to NPM. There is no point to add them right now.

cd1m0 commented 2 years ago

Should license be an Apache 2.0 like we use in other ConsenSys repos? Or keep it GPL 3.0 as it currently is?

Good question. Will check with ppll.

blitz-1306 commented 2 years ago

Integrated CodeCov and CodeCov/NPM badges in #8.

Coverage reports would be stored at https://codecov.io/gh/ConsenSys/sol-dbg/ when we will merge PR to main branch.

blitz-1306 commented 2 years ago

I guess we can close this issue.