Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

51 lines (32 loc) · 1.51 KB
Raw

Commit guidelines

TL;DR: We use conventional commits for commit messages. We check that commits follow this convention. If you want to ensure compliance before sending a pull-request, please read on.

How to ensure commits follow guidelines before sending a pull-request

Install precommit

>pip3 install pre-commit

Install golangif not already present (needed for conform)

See if you have golang. E.g.

>go version
go version go1.14.2 linux/amd64

Enable precommit inside root of local git repo

>pre-commit install

If you don't have it installed, you can install it using these instructions..

Install pre-commit into the commit-msg hook

 pre-commit install -t commit-msg

Everything is now setup. seahorn contains the following configuration files (you should not need to change them).

  • .pre-commit-config.yaml - This is the configuration for pre-commit i.e. which checks to run e.g. conform, clang-format
  • .conform.yaml- This is the configuration used by conform to figure out which checks to enable e.g. conventional commits.

Run checks

You can manually run a check from within a repo using

>pre-commit run

Checks will automatically be run during git commit.