Skip to content

Latest commit

 

History

History
27 lines (17 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

27 lines (17 loc) · 1.29 KB

Contributing to kimchi

Here's all you need to know to start contributing to kimchi.

Navigating the project

  • The following video goes over the project organization.
  • The Mina book contains specifications, rust documentation, RFCs, and explainers on the different aspects of the system.
  • The Discussion page can be used to start discussions or ask questions.

Finding a task

We have a list of easy task to start contributing. Start over there.

Setting up the project

Mac & Linux

Windows Development

Windows development can be done using Windows Subsystem for Linux (WSL).

  • Install and open WSL
  • Within WSL, install OCaml using your distro's package manager. For example: apt install opam
  • Within WSL, navigate to the project directory and run cargo test. If there are no failures then everything is set up correctly.