Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (29 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

48 lines (29 loc) · 1.02 KB
Raw

Contributing

Setup

Fork, then clone the repo:

git clone git@github.com:<your-username>/circ.git

Install the dependencies, see README.md.

Install the development dependencies:

  • clang (for clang-format, clang-tidy)

Install the Git Hooks

Symlink .githooks to .git/hooks.

Push to your fork, then submit a pull request

Styleguide & Linting

  • Please get rid of any warnings clang-format and clang-tidy spew.
  • Put a space before parens.
  • Use snake case.
  • Don't code like a rockstar.

See editor configuration for integrating with the above.

Editor Configuration

Vim

If you use Vim + ALE, you can set it up to lint source files with:

let g:ale_fixers = { }
let g:ale_fixers['c'] = ['clang-format']

let g:ale_linters = { }
let g:ale_linters['c'] = ['clangtidy']

Reformat source files with clang-format with ALEFix.

Please ensure you have the development dependencies installed.