Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (24 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 2.61 KB
Raw

Contributing to ERC-8183

This repository contains the reference implementation of ERC-8183.
It serves as the canonical codebase for the standard and a starting point for proposals to improve it.

Contributions are welcome — whether that's bug fixes, security improvements, or proposals that evolve the standard itself (e.g., changes to the job lifecycle, fee mechanics, or core interface).

Looking to contribute or explore hook implementations? Hook contracts for different applications and use cases live in a separate repository: erc-8183/hook-contracts

Proposing changes to the standard

If your contribution changes the behavior or interface of the protocol (not just implementation details), please open an issue first to discuss the rationale before submitting a supporting PR.

Contribution process

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Contributor Guide

You may follow these steps to contribute:

  1. Fork the official repository. This will create a copy of the official repository in your own account.
  2. Sync the branches. This will ensure that your copy of the repository is up-to-date with the latest changes from the official repository.
  3. Work on your forked repository's feature branch. This is where you will make your changes to the code.
  4. Commit your updates on your forked repository's feature branch. This will save your changes to your copy of the repository.
  5. Submit a pull request to the official repository's main branch. This will request that your changes be merged into the official repository.
  6. Resolve any linting errors. This will ensure that your changes are formatted correctly.

Here are some additional things to keep in mind during the process:

  • Test your changes. Before you submit a pull request, make sure that your changes work as expected.
  • Update docs with contract-surface changes. If a change adds, removes, or changes a public/external contract function, event, error, storage getter, role, or authorization flow, update README/docs/NatSpec in the same commit or explain why no documentation change is needed.
  • Be patient. It may take some time for your pull request to be reviewed and merged.