Contribution guidelines

Design Guidelines

Some general design goals.

D0 - Simple code

Small files, small contracts, and small functions when possible.

D1 - Naming

Self descriptive and short names.

D2 - Tests

Strive to reach 100% coverage.

D3 - Consistency

Consistent use of function styles and purposes.

Style Guidelines

Guidelines for coding style.

Contracts

C0 - Solidity style guide

When in doubt always follow the official Solidity style guide: https://solidity.readthedocs.io/en/latest/style-guide.html

Additional rules in: https://github.com/NFhbar/SingleTxMultisig/blob/master/.soliumrc.json

Testing

T0 - Tests style

Follow the style rules in: https://github.com/NFhbar/SingleTxMultisig/blob/master/.eslintrc.js

T1 - Tests must be small and easy

Keep tests short and precise.