Kleros
Kleros.ioGithub
  • Introduction to Kleros
  • Kleros FAQ
  • Governance
  • PNK Token
  • They talk about Kleros
  • Products
    • Court
      • Kleros Juror Tutorial
      • Famous Kleros Cases
      • What happens during a dispute?
      • Kleros & Credible Neutrality
    • Court V2
    • Proof of Humanity
      • Proof of Humanity 2.0 Tutorial: (Register & Vouch)
      • Proof of Humanity 2.0 Tutorial (Remove & Challenge)
      • Proof of Humanity 2.0 Tutorial (Transferring a Profile)
      • Proof of Humanity 2.0 Integration Guide
      • Proof of Humanity FAQ
        • Proof of Humanity 2.0 launch FAQ
    • Curate
      • Kleros Curate Tutorial
      • Kleros Scout
        • Tutorial
        • Earn With Kleros Scout
        • Partnerships
        • Kleros Scout - Metamask Snaps
          • Knowledge Base
        • FAQs
    • Oracle
    • Governor
    • Escrow
      • Kleros Escrow Tutorial
      • Kleros Escrow Specifications
    • Linguo
      • Kleros Linguo Tutorial
      • Step-by-step Tutorial
        • Requesting translations
        • Working as a translator
        • Reviewing translations
      • F.A.Q
      • High-level Overview
    • Moderate
      • Susie
        • Getting Started
          • Add Susie
          • Start Susie
        • Basics
          • Welcome
          • Language
          • Notifications
        • Rules
        • Reports
        • Evidence
        • Federations
  • INTEGRATIONS
    • Overview
    • Industry use cases
    • Types of Integrations
      • 1. Dispute resolution integration plan
        • Smart contract integration with Kleros Court (Arbitrator)
        • Use Cases
          • DeFi Insurance
          • Gaming
          • Recognition of Jurisdiction Integration
            • Integración por Reconocimiento de Jurisdicción
        • Channel partners
          • How to use Reality.eth + Kleros as an oracle
          • Safe Zodiac integration
          • Kleros Reality Module
        • Integration Tools
          • Centralized Arbitrator
          • Dispute Resolver
      • 2. Curated-data integration plan
        • Retrieving information from Kleros Dapps
    • Policy writing guide
    • Live & Upcoming Integrations
    • Kleros Analytics
    • Scalability & Cross-chain
      • Using Kleros arbitration for Dapps on xDai/Gnosis
    • Integrations FAQ
  • Developers
    • Arbitration Development
      • ERC-792: Arbitration Standard
      • ERC 1497: Evidence Standard
      • Arbitrable Proxy
    • Arbitration by Example
      • ArbitrableDeposit.sol
      • TwoPartyArbitrable.sol
      • Rental.sol
      • ArbitrableTransaction.sol
      • MultipleArbitrableTransaction.sol
      • MultipleArbitrableTokenTransaction.sol
    • Deployment Addresses
    • Curate Classic: Integration for Devs
    • Light Curate: Integration for Devs
    • Guide for Preparing Transactions
  • Contribution Guidelines
    • Overview
    • General Dev. Workflow
      • Task Tracking & Lifecycle
      • Releases
    • Smart Contract Workflow
      • Task Tracking & Lifecycle
      • RAB - Review, Audit, Bounty
      • RABd (+ Deploy)
      • Reporting Vulnerabilities
    • Code Style and Guidelines
      • Git
      • Solidity
      • Web Languages
    • License & Code of Conduct
      • License
      • Code of Conduct
  • Additional Resources
    • Discord
    • Telegram
    • Governance Forum
    • Twitter
    • Blog
    • Reddit
    • Github
    • Slack
Powered by GitBook
On this page
  • How to contribute?
  • Table of Contents
  • Kathari CLI [Deprecated]
  • Main Repos
  • Referencing This Guide

Was this helpful?

Edit on GitHub
  1. Contribution Guidelines

Overview

Welcome to the contribution guide for all software pertaining to Kleros.

PreviousGuide for Preparing TransactionsNextGeneral Dev. Workflow

Last updated 2 years ago

Was this helpful?

How to contribute?

The purpose of these guidelines is to serve as a living contribution and collaboration guide for all our projects.

Everyone, not just Kleros team members, is welcome to participate in its writing and editing. We are always looking to enhance and improve our processes so we can decentralize justice faster!

Table of Contents

This guide is a compilation of years of experience in the fields of traditional software engineering, and smart contract and financial software auditing. We've broken it down into three parts:

General Workflow
Smart Contract Workflow
Code Style & Guidelines
License & Code of Conduct

General process and standards for writing and pushing software.

Smart contract specific security protocols.

Stylistic guidelines for our main languages and tools.

Our standard license and conduct guidelines.

Kathari CLI [Deprecated]

To make following our standards easier, we made , a linting and formatting scripts for multiple types of projects.

Kathari means "Clean" in Greek.

It's a CLI that can easily be integrated into new projects to provide automatic linting and formatting that adheres to our standards on everything from code to git commit messages.

It's based on very popular open source technologies so there are integrations for all of the most popular text editors and IDEs.

Main Repos

  • - arbitrator implementation smart contracts.

  • - Arbitrable smart contracts and other contracts that can interact with Kleros.

  • - Wrapper that simplifies interfacing with smart contracts that adhere to the and standards.

Referencing This Guide

All of our projects' CONTRIBUTING.md files should link to this page, but they can also specify their own project-specific guidelines in that same file.

The rules in this guide are meant to be followed as much as possible, but should not override common sense.

The golden rule is that there are no golden rules.

-George Bernard Shaw-

This site is maintained at and hosted at !

Kathari
kleros
Kleros whitepaper
kleros-interaction
archon
arbitration (ERC792)
evidence (ERC1497)
github.com/kleros/CONTRIBUTING.md
contributing.kleros.io