Skip to content

Latest commit

 

History

History
84 lines (51 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

84 lines (51 loc) · 3.52 KB
Raw

Contributing

Welcome! 👋

Hello there, contributor! We're delighted that you're considering contributing to the zksync2-examples project. This document is here to guide you through the steps and best practices for contributing to this repository.

Please take a moment to review this document to ensure a smooth and efficient contribution process for everyone involved.

Getting Started

  • Fork the repository. Begin by forking the main zksync2-examples repository to your personal GitHub account.

  • Clone the repository. After forking, clone the repository to your local machine:

git clone https://github.com/<your-github-username>/zksync2-examples.git
  • Create a new branch. Use descriptive names for your branches to help identify the feature, bugfix, or enhancement you're addressing:
git checkout -b feature/description-of-your-feature

Making Changes

Go examples

  • Write your code. Ensure your code is thoroughly tested and functions as expected. Code must be documented adhering to the official Go commentary guidelines.
  • Compile and test. Before submitting a pull request, ensure your code compiles, passes lint checks, and all tests are successful. You should also write unit tests for your contributions.
  • Lint your code. Follow basic coding style guidelines and ensure your code is formatted and lint checks pass.

Use the following commands for these checks:

gofmt -w .
got test ./test/...

JavaScript examples

  • Write your code. Ensure your code is thoroughly tested and functions as expected. Code must be documented adhering to the official Go commentary guidelines.
  • Compile and test. Before submitting a pull request, ensure your code compiles, passes lint checks, and all tests are successful. You should also write unit tests for your contributions.
  • Lint your code. Follow basic coding style guidelines and ensure your code is formatted and lint checks pass.

Use the following commands for these checks:

yarn lint
yarn test
yarn types
yarn build

Submitting changes

  • Commit your changes. Adhere to the Conventional Commits standard when writing commit messages.

  • Push your changes. Push the changes to your forked repository:

git push -u origin feature/description-of-your-feature

Submitting a Pull Request

  • Initiate a pull request (PR). Go to the main zksync2-go repository. Your recently pushed branch should be highlighted, showing a "Compare & pull request" button. Click on it and provide a clear, detailed description of your changes in the PR.

  • Await a review. Our maintainers will review your PR. They might request changes or clarifications, so be ready to address any feedback.

Need Assistance?

If you're unsure about something or have questions, don't hesitate to open an issue or initiate a discussion in our zkSync Community Hub. We're here to assist!

What's Next?

Once your PR is approved and merged, your contribution will be integrated into the zksync2-go repository. Congratulations, and thank you! We value your contribution and look forward to future collaborations.

Remember, the best contributions come from enjoying the process, being respectful, and continuously learning. Thanks for being a part of our community!

Last updated: Dec 22, 2023