Skip to content

Latest commit

 

History

History
103 lines (75 loc) · 4.84 KB

CONTRIBUTING.md

File metadata and controls

103 lines (75 loc) · 4.84 KB
Raw

Contributing to Miden Client

First off, thanks for taking the time to contribute!

We want to make contributing to this project as easy and transparent as possible, whether it's:

Flow

We are using Github Flow, so all code changes happen through pull requests from a forked repo.

Branching

  • The current active branch is next. Every branch with a fix/feature must be forked from next.

  • The branch name should contain a short issue/feature description separated with hyphens (kebab-case).

    For example, if the issue title is Fix functionality X in component Y then the branch name will be something like: fix-x-in-y.

  • New branch should be rebased from next before submitting a PR in case there have been changes to avoid merge commits. i.e. this branches state:

            A---B---C fix-x-in-y
       /
  D---E---F---G next
          |   |
       (F, G) changes happened after `fix-x-in-y` forked

    should become this after rebase:

                    A'--B'--C' fix-x-in-y
               /
  D---E---F---G next

    More about rebase here and here

Commit messages

  • Commit messages should be written in a short, descriptive manner and be prefixed with tags for the change type and scope (if possible) according to the semantic commit scheme. For example, a new change to the miden-node-store crate might have the following message: feat(miden-node-store): fix block-headers database schema

  • Also squash commits to logically separated, distinguishable stages to keep git log clean:

    7hgf8978g9... Added A to X \
                            \  (squash)
gh354354gh... oops, typo --- * ---------> 9fh1f51gh7... feat(X): add A && B
                            /
85493g2458... Added B to X /


789fdfffdf... Fixed D in Y \
                            \  (squash)
787g8fgf78... blah  blah --- * ---------> 4070df6f00... fix(Y): fixed D && C
                            /
9080gf6567... Fixed C in Y /

Code Style and Documentation

  • For documentation in the codebase, we follow the rustdoc convention with no more than 100 characters per line.

  • We also have technical and user documentation built with mkdocs. You should update it whenever architectural changes or public interface (cli, client lib, etc.) changes are being made.

  • For code sections, we use code separators like the following to a width of 100 characters::

    // CODE SECTION HEADER
// ================================================================================

  • Rustfmt, Clippy and Rustdoc linting is included in CI pipeline. Anyways it's preferable to run linting locally before push. To simplify running these commands in a reproducible manner we use make, you can run:

    make lint

You can find more information about other make commands in the Makefile

Versioning

We use semver naming convention.

Pre-PR checklist

  1. Repo forked and branch created from next according to the naming convention.
  2. Commit messages and code style follow conventions.
  3. Tests added for new functionality.
  4. Documentation/comments updated for all changes according to our documentation convention.
  5. Rustfmt, Clippy and Rustdoc linting passed.

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.