Skip to content

Latest commit

 

History

History
76 lines (62 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

76 lines (62 loc) · 3.45 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project.

Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? Take a look at GitHub Discussions to see if it's already being discussed. You can help us by submitting an issue on GitHub. Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

Please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing opened issues.
  • Scoped to a Single Bug. One bug per report.

Even better: Submit a pull request with a fix or new feature!

How to submit a Pull Request

  1. Search our repository for open or closed Pull Requests that relate to your submission. You don't want to duplicate effort.
  2. Fork the project
  3. Create your feature branch (git checkout -b feat/amazing_feature)
  4. Commit your changes (git commit -m 'feat: add amazing_feature')
  5. Push to the branch (git push origin feat/amazing_feature)
  6. Open a Pull Request

Development environment setup

In order to set up a development environment, First clone the repository:

git clone https://github.com/starkware-libs/papyrus

Then, you will need to install

  • Rust (1.73 or higher)
  • Rust nightly toolchain 2022-07-27
  • Ganache 7.4.3
    • You'll need to install 7.4.3 and not a version above it. We'll relax this in the future.
    • You'll need Ganache only for the tests of the papyrus_base_layer crate.
  • Protoc

    • You'll need Protoc only for compiling the papyrus_network crate.

    • Make sure you have version 15 or higher installed. If not:

      1. Remove your current Protoc installation:
      sudo apt remove protoc/protobuf-compiler
      1. Install version 15 or higher:
      DIR="$HOME/.local"
curl -L "https://github.com/protocolbuffers/protobuf/releases/download/v25.1/protoc-25.1-linux-x86_64.zip" -o protoc.zip
unzip ./protoc.zip -d $DIR
rm ./protoc.zip

      Replace DIR with your preferred installation directory.

      1. Add DIR to your PATH if it's not already there:
      export PATH=$PATH:$DIR/bin

CI

Your code will need to pass CI before it can be merged. This means your code will need to:

  • Pass all local tests and all integration tests.
  • Be formatted according to rustfmt.
  • Be linted according to clippy
  • Not include unused dependencies (Checked by udeps).