Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

62 lines (38 loc) · 2.56 KB

Taiko contributing guide

Table of contents:

Make a contribution

Here are some ways you can contribute:

Check out the coding standards and documentation standards before you start working on a pull request.

Claim a Taiko Contributor GitPOAP

A Taiko Contributor GitPOAP is rewarded to anyone that merges in a pull request to one of Taiko's GitHub repositories (for example: 2023 Taiko Contributor GitPOAP).

After your pull request is merged, a bot will automatically leave a comment with instructions to receive your GitPOAP. You only receive a Taiko Contributor GitPOAP for the first pull request you merge in a given year.

Coding standards

Pull requests

Specify the scope of your change with a conventional commit in the PR title (for example, feat(scope): description of feature). This will be squashed and merged into the main branch.

Source code comments

Follow the NatSpec format for documenting smart contract source code. Please adhere to a few additional standards:

  • Choose /** */ over /// for multi-line NatSpec comments to save column space.
  • Omit the usage of @notice and let the compiler automatically pick it up to save column space.
    • For example: /** @notice This is a notice */ becomes /** This is a notice */.

Documentation standards

Use the Microsoft Writing Style Guide as a base point of reference.

Philosophy

  • Create the minimum viable documentation.
  • Don't repeat yourself, use links to existing documentation or inherit it.
  • Keep documentation close to what it's describing (for example, in the source code).

Document types

Group documentation under one of the four categories (adopted from Diátaxis):

  • How to
  • Concepts
  • Tutorials
  • Reference

Images

  • Use SVG files or crushed PNG images.
  • Provide alt text.