Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 916 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 916 Bytes

Zilliqa Coding and Review Guidelines

  1. All submitted Pull Requests are assumed to be ready for review.
    If not, they must be marked with explicit [in progress] or have "[WIP]" in title.

    • Pull requests which fix a bug should have branch name starting with fix/
    • Pull requests which add a feature to the codebase should have branch name starting with feature/
    • Pull requests which are made by outside contributors should also contain their name.
    Example:
       john/fix/xxx
    
  2. All Pull Requests which are not ready to be merged yet but are open for review should be marked with explicit
    on hold or should be a draft.

    • To build your code with clang-format, use ./build.sh style
    • To build your code with clang-style, use ./build.sh linter
  3. Kindly go through .clang-format and .clang-style to see the format and checks enabled