Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Contributing

How to contribute to Taiko docs, tooling, and protocol repositories.

Ways to Contribute

You do not need to be working on protocol code to make a useful contribution.

Common contribution paths:

  • improve or fix documentation
  • report bugs with clear reproduction steps
  • work on existing issues
  • contribute tooling, client, or contract improvements
  • improve tests, examples, and operator runbooks

Where to Contribute

Taiko work is spread across several repositories:

Before You Open a PR

  • Check whether an issue already exists
  • Keep the scope focused and coherent
  • Include docs updates when behavior or interfaces change
  • Include tests when code behavior changes

Taiko repositories generally expect Conventional Commits style PR titles such as feat(scope): description.

Documentation Contributions

For docs changes:

  • prefer concise pages over long marketing copy
  • link to canonical sources for addresses, releases, and protocol constants
  • update related navigation when you add new pages
  • preserve the current information architecture unless there is a strong reason to change it

Code Contributions

Language- and repo-specific conventions can vary by repository, so read the local contributing instructions before starting larger changes. For protocol and client work, keep changes well-scoped and documented, especially when modifying consensus behavior, proving logic, or deployment/configuration flows.

Getting Started

If you are looking for a first contribution:

  • open an issue in the relevant repo
  • comment that you want to work on it
  • ask in Discord if ownership or scope is unclear

Smaller docs, tooling, and usability fixes are usually the easiest place to start.