Thank you for your interest in contributing to Blobscan! We welcome contributions from everyone, and this document provides some guidelines to make the contribution process smoother.

Code of Conduct

All contributors are expected to follow our Code of Conduct. Please make sure you are welcoming and friendly in all our spaces.

Getting Started

Ensure you have a GitHub account.
Look for an issue to tackle in our issue tracker on GitHub.
Once you've chosen an issue, comment on it to let others know you're working on it.

Making Changes

Begin by setting up Blobscan locally.
Proceed to make your changes.
Ensure you've tested your changes comprehensively. Refer to our Testing Guide for details on our testing setup.
Once done, push your changes to your GitHub fork.
Create a pull request against our main repository.

Contact

If you have questions or need help with your contribution, join our Discord server and ask in the #🔎-blobscan channel.

Examples

Add support for a new network

Steps:

Update Network type in package network-blob-config
Update networkSchema in web app

Check out the following PRs:

https://github.com/Blobscan/blobscan/pull/823
https://github.com/Blobscan/blobscan/commit/0a2a94c587e9b93f6b36ad15fd55065e824b5049
https://github.com/Blobscan/blobscan/pull/826

Add a new storage provider

Steps:

Add new environment variables, if required
Update documentation
Add svg icon (StorageBadge component)
Add a new BlobPropagationWorkerProcessor
Add tests for the new storage provider

Check out the following PRs

https://github.com/Blobscan/blobscan/pull/820

Label a new rollup

TBW