Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 2.14 KB
Raw

Welcome to the zkSync Remix Plugin Contribution Guide!

Getting Started

Welcome to the zkSync-remix-plugin contribution guide! This project is aimed at creating an easy way to onboard developers to the zkSync Ecosystem. For a detailed introduction and setup instructions, please refer to the README.md file.

New Contributor Guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

How Can You Collaborate?

Issues

If you've found a bug, have a suggestion, or need a new feature, please start by checking if there's already an existing issue. If not, feel free to create a new one. When creating an issue:

  1. Use a clear and descriptive title.
  2. Describe the issue in detail, including steps to reproduce if it's a bug.
  3. Attach any relevant data or logs if possible.

Pull Requests

We welcome and appreciate pull requests. Here's how you can submit one:

  1. Fork the Repository: If you're not a direct contributor, start by forking the repository.
  2. Create a New Branch: Always create a new branch for your changes. This keeps the main branch clean and makes it easier to review your changes.
  3. Make Your Changes: Ensure your code adheres to the existing style to maintain consistency.
  4. Describe Your Changes: When creating a pull request, please provide a clear and detailed description of the changes, why you made them, and any relevant issues or discussions.
  5. Submit the Pull Request: Once ready, submit your pull request. We'll review it as soon as possible and provide feedback or merge it.

Thank You!

We truly appreciate your interest in contributing to zkSync-remix-plugin. Every contribution, no matter how small, helps us improve and grow the project.