Skip to content

Latest commit

 

History

History
21 lines (13 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

21 lines (13 loc) · 1.82 KB
Raw

Contributing

Getting started

  1. Install docker.
  2. Clone this respository onto your machine.
  3. Open a shell terminal and cd into the root of the project directory.
  4. Run docker build ./ which should terminate with Successfully built xxxxxxxxxxxx
  5. (Optional) Copy xxxxxxxxxxxx into your clipboard and run docker run xxxxxxxxxxxx cat target/git-hooks.zip > target/git-hooks.zip to extract the built archive.

Code Quality

You will hopefully have noticed that the build is running shellcheck on all the shell scripts written in the project. Additionally, you will likely have noticed that the build runs tests on each hook individually and then an integration test at the end.

Before raising a pull request, please ensure that the build runs successfully, and that you have written new unit tests for any new functionally you have added (or bugs you have fixed etc). Additionally, please carefully consider alternatives before adding new programs to the docker build environment. The fewer are used, the easier it will be to maintain compatibility.

Public API

The public API for using and configuring the hooks provided in this library needs to be kept consistent. If you add a new hook please ensure that the new hook is named descriptively using two dash separated words. Configuration for that hook should be added using git config and the configuration key should be a three part key where the first two parts are hooks.your-hook where your-hook is the name of the new hook. All hooks should have a hooks.your-hook.disabled option available.

All hooks will require a dedicated markdown file in the documentation directory, and a link to this new file in the main README.md. If you need to change any of the existing configuration, please ensure the documentation is kept up-to-date.