Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 4.61 KB

CONTRIBUTING.md

File metadata and controls

83 lines (53 loc) · 4.61 KB
Raw

Contributing to Immutable zkEVM Contracts

We greatly appreciate all community feedback and contributions to this repository. This guide will walk you through the different ways you can contribute, including opening GitHub issues, pull requests, requesting features, and providing general feedback. For any security disclosures, please email security@immutable.com.

Opening an issue

GitHub issues are a great way to discuss and coordinate new features, changes, bugs, etc.

You should create an issue to open discussions when:

  • Before starting development on a significant pull request - Use GitHub issues as a way to collaboratively propose, design, and discuss any development work you plan to do.
  • Proposing new features or ideas - If you just have an idea or feature you'd like to see, drop the details into a GitHub issue for us to keep track of. Be specific with any requests, and include descriptions of what you would like to be added and what problems it would solve.
  • Reporting a bug or minor security vulnerability - As above, opening an issue helps us keep track of and prioritize any bugs or minor security vulnerabilities. Make sure to include all the relevant information, e.g. code snippets, error messages, stack traces, environment, reproduction steps, etc, to help us effectively diagnose and address the issue. Please also reach out to security@immutable.com.

There is usually no need to create an issue when:

  • An issue or open PR for the topic already exists - Please continue or reopen the existing thread to keep all the discussion in one place.
  • The PR is relatively small and obvious (e.g. small fixes, typos, etc) - If the changes do not require a discussion, simply filling out the PR description template will suffice.
  • Providing comments or general feedback - Please use GitHub issues for actionable feedback or tasks (e.g. feature requests or bugs).

Opening a Pull Request

If you'd like to contribute to the code and open a pull request (PR), here are some general guidelines to follow:

  • Most PRs should have an accompanying GitHub issue (see above on opening issues). When submitting your PR for review, please link the corresponding issue in the PR description.
  • Alongside every PR there should be a brief summary of what changes have been made and why, as per the PR template we provide. Be sure to fill this out to help share context with the reviewers and others.
  • Please follow existing code styles to keep formatting in this repository consistent.

Contributor workflow

To start contributing to this repository, have a look at this guide to contributing to open source projects.

You should fork the repository and make your changes in your local repository under a new branch, before opening a pull request for your branch back upstream to the original repository. This is a helpful guide that walks through all of these steps in detail.

  1. Fork the repository (Fork button in the top right of the repository GitHub UI).
  2. Clone your fork to your local machine.
git clone https://GitHub.com/<your-GitHub-username>/<repository-name>.git
  1. Add the original repository as the upstream remote.
cd <repository-name>
git remote add upstream https://GitHub.com/immutable/<repository-name>.git
  1. Make sure your fork is up to date with the original repository (if necessary).
git pull upstream main
  1. Create a new branch and make your changes.
git checkout -b <your-branch-name>
  1. Be sure to run the tests and set up the relevant linters to ensure all GitHub checks pass (see GitHub issues: https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues for more information).
yarn test
  1. Add and commit your changes, including a comprehensive commit message summarising your changes, then push changes to your fork. (e.g. Fixed formatting issue with ImmutableERC721MintByID.sol)
git add *
git commit -m "fix typos"
git push origin <your-branch-name>
  1. Open a pull request into the original repository through GitHub in your web browser. Remember to fill out the PR template to the best of your ability to share any context with reviewers.

IMPORTANT: Please make sure to read through the cla file as part of opening a pull request.

  1. We will review the pull requests and request any necessary changes. If all the checks (linting, compilation, tests) pass and everything looks good, your code will be merged into the original repository. Congratulations, and thank you for your contribution!

Releasing

To release the package to NPM, simply create a new GitHub release and the "Publish to NPM" GitHub action will release it to NPM.