Contribution Track

Introduction

Welcome to the zkSync Contributors Track! The purpose of this track is to accelerate your journey into the thriving zkSync development landscape. As a fully open-source project, we believe in community-driven development, and that means anyone from anywhere can contribute to shaping the future of zkSync.

This track aims to guide you in discovering various aspects of our project, inspire you to contribute in the ways that interest you most, and provide a pathway to connect with the zkSync community.

Open-Source Repositories

Here's a list of our key open-source repositories that you can contribute to:

zkSync Era

• zkSync Era: Node implementation for zkSync Era.

Smart Contracts

• era-contracts: Submodule containing the smart contracts for zkSync Era.

Circuit Implementation

• era-sync_vm: Houses the circuit implementation of zkVM specifically for zkSync Era.

Testing and Debugging

• era-test-node: An in-memory node designed for integration testing and debugging.

Development Tools

• zksync-cli: CLI tool that aims to simplify the development process on zkSync.
• hardhat-zksync: Hardhat plugins tailored for the zkSync Network.

Documentation

• zksync-web-era-docs: The go-to source for official zkSync documentation.

SDK and Explorers

• block-explorer: The official block explorer for navigating the zkSync network.
• zksync-sdk: Software Development Kit for ease of integration with the zkSync network.

Feel free to explore these repositories, and don't hesitate to contribute!

Why the Contributors Track?

Purpose

• Facilitate easy entry for external contributors into zkSync's development ecosystem.
• Offer a structured approach to involvement, reducing the initial overwhelm of diving into a new project.
• Build a strong, diverse, and global community of developers who are excited about zkSync.

Who is it for?

• Developers interested in blockchain and layer 2 solutions.
• Open-source enthusiasts looking to contribute to a growing project.
• Those interested in contract development, dApp development, zkSync Era, and more.

The Track

Getting Started

1. Introduce Yourself on zkSync Discord

• Join our Discord channel and say 'hi' in the #introductions thread. Share what interests you and what you're hoping to learn or contribute.

2. Follow zkSync Developers on X (formerly Twitter)

• Keep up to date with the latest news, updates, and releases by following us on X.

3.Dive into our official documentation

• Immerse yourself in our comprehensive official documentation to acquire essential knowledge on zkSync. If you discover a typo, syntax error, or see room for improvement, submit a Pull Request to contribute to its enhancement.

Dive Into Development

4. Deploy Your First Contract Using zkSync-CLI

• Familiarize yourself with the zkSync-CLI tool and deploy your first contract on the zkSync Era testnet. Checkout the zkSync-cli documentation here.

5. Tackle a 'Good First Issue'

• Start contributing immediately by taking on a "Good First Issue" from any of our GitHub repositories. This is a great way to get hands-on experience and a feel for the project.

Community Engagement

6. Participate in zkSync Developer Discussions

• Join the discourse on GitHub discussions or other community forums to provide answers, ask questions, or share insights.

7. Submit a Community Tutorial or Guide

• Help others by sharing your knowledge. Write a tutorial or guide, then submit it to our community contributions repository or community forums