zksync-sdk / zksync2-js

MIT License
25 stars 29 forks source link

open source repo setup #8

Closed danijelTxFusion closed 11 months ago

danijelTxFusion commented 11 months ago
* is the main branch protected? I'd recommend people open PRs to merge to `develop-vX` branch (both ethv5 and ethv6 would need one) and develop is merged once every now and then just before a release

Yes, main and ethers-v5 are protected. If develop branch is meant to be integration branch then this should be mentioned in the CONTRIBUTION.md file.

* I would also add a GitHub Action that runs on every pull request to the develop branch and on every merge to main branch asserting the lint, format, and runs the unit tests for the repo

The CI pipeline is the next thing that should be implemented. The idea is to use semantic-release for creating releases and generating changelog files. I need to test it to see how it behaves because we have two SDKs with different versions and tags, which could create some problems because semantic-release uses tags to calculate the next release.