mirror of
https://github.com/carp-lang/Carp.git
synced 2024-08-16 00:30:24 +03:00
1863c82559
* chore: moves git hook into own folder This is is done in preparation of having other git hooks * chore: Creates script to run formatter * chore: Checks that ormolu is installed before running it * chore: Adds pre-commit hook to format Haskell files * chore: Ensures the ormolu instruction are outputted when running hook * chore: Prints formatted files on newlines
23 lines
823 B
Markdown
23 lines
823 B
Markdown
# Contributing Guide
|
|
|
|
Thank you for considering contributing to Carp!
|
|
|
|
This document currently focuses on developer contributions but we welcome all kinds of contributions.
|
|
|
|
## Community
|
|
The best place to start is to join the Carp Gitter channel over at
|
|
[https://gitter.im/carp-lang/Carp](https://gitter.im/carp-lang/Carp).
|
|
|
|
## Understanding the Compiler
|
|
See [Hacking.md](hacking.md) for a gentle introduction to the Carp compiler internals.
|
|
|
|
## Committing to the repo
|
|
We follow [Conventional Commits](https://www.conventionalcommits.org), there is
|
|
a `commit-msg` hook to ensure the messages follow the convention, please make
|
|
sure you have run `./scripts/git-hooks/setup.sh` before you commit the first
|
|
time so that the hook is in place.
|
|
|
|
License
|
|
-------
|
|
Carp is currently released under the terms of the ASL 2.0 license.
|