Skip to content

Latest commit

 

History

History
27 lines (14 loc) · 1.52 KB

README.md

File metadata and controls

27 lines (14 loc) · 1.52 KB
Raw

L2BEAT 💓

L2BEAT (Layer 2 Beat) is a website dedicated to providing research and statistics about the very exciting layer 2 technology on Ethereum.

You can visit the site yourself at https://www.l2beat.com/.

Contributing

We welcome and encourage contributions. To learn about the project structure and contributions please read CONTRIBUTING.md.

🔍 Here is also a visual step-by-step guide for creating a Pull Request - link

License

We believe in knowledge sharing and open access. Our code is and will remain open source with the permissive MIT license.

Versioning and publishing (tooling)

Some of the sub-packages are published to NPM. We use a tool called changesets to manage versioning, cross-dependency versioning and publishing new versions to NPM. When you make a change, before merging to master:

  • run pnpm changeset and mark the packages you wish to publish, select what kind of a change it is (major,minor,patch) and provide the summary of the changes

When you want to publish all previous changes to NPM:

  • now run pnpm changeset version, this will change the generated .changeset/file.md into an entry into CHANGELOG.md and package.json in changed packages

After your PR with changed CHANGELOG.md and package.json is merged into main, a CI step will run which will try to publish all change changes.