Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.43 KB

Thank you for your contribution to cryptography-blake3! While there is no Contributor License Agreement (CLA) to sign, we do need you to read the following instructions before you contribute.

Code of Conduct

We need you to read, acknowledge, and abide by our Code of Conduct.

Pull Requests

When making a PR, ensure that you have a Github issue that explains the context for your changes.

Formatting and linting

We have a git hook in place to ensure the following formatting and linting tools are being used:

  • All Haskell source files are formatted with ormolu;
  • All Haskell source files are linted with HLint, as per the .hlint.yaml configuration file.
  • The Cabal file is formatted with cabal-fmt

To ensure that you are using the git hook, run the following, once:

git config core.hooksPath .githooks

You can also use the provided Makefile by running make init.

Questions

Open a thread in the [Questions][Questions board] discussion board. That way, you can get help from everyone in the community.

Issues & Bugs

Open an issue and tell us what you can about your problem.