carp-lang/Carp
1
1
Fork 0
mirror of https://github.com/carp-lang/Carp.git synced 2024-08-16 00:30:24 +03:00
Code Issues Projects Releases Wiki Activity
master
Carp/docs/Contributing.md

23 lines
823 B
Markdown
Raw Permalink Normal View History

chore: Creates git hook to enforce Conventional Commits (#1041) * chore: Adds Conventional Commits commit-msg hook * docs: Adds section about git hooks in Contributing Guide & fixes the headers hierarchy
2020-12-01 16:38:45 +03:00
# Contributing Guide
Language guide.
2017-06-26 12:45:18 +03:00
docs: Better credits and contribution guide (#1010) * docs: Cleaned up the "credits" section a fair bit * docs: Unified list of maintainers * Update README.md Co-authored-by: Erik Svedang <erik@Eriks-iMac.local>
2020-11-24 18:47:44 +03:00
Thank you for considering contributing to Carp!
Language guide.
2017-06-26 12:45:18 +03:00
This document currently focuses on developer contributions but we welcome all kinds of contributions.
chore: Creates git hook to enforce Conventional Commits (#1041) * chore: Adds Conventional Commits commit-msg hook * docs: Adds section about git hooks in Contributing Guide & fixes the headers hierarchy
2020-12-01 16:38:45 +03:00
## Community
Language guide.
2017-06-26 12:45:18 +03:00
The best place to start is to join the Carp Gitter channel over at
docs: fix some typos and minor grammatical errors
2020-07-26 01:30:37 +03:00
[https://gitter.im/carp-lang/Carp](https://gitter.im/carp-lang/Carp).
Language guide.
2017-06-26 12:45:18 +03:00
chore: Creates git hook to enforce Conventional Commits (#1041) * chore: Adds Conventional Commits commit-msg hook * docs: Adds section about git hooks in Contributing Guide & fixes the headers hierarchy
2020-12-01 16:38:45 +03:00
## Understanding the Compiler
docs: Better credits and contribution guide (#1010) * docs: Cleaned up the "credits" section a fair bit * docs: Unified list of maintainers * Update README.md Co-authored-by: Erik Svedang <erik@Eriks-iMac.local>
2020-11-24 18:47:44 +03:00
See [Hacking.md](hacking.md) for a gentle introduction to the Carp compiler internals.
Language guide.
2017-06-26 12:45:18 +03:00
chore: Creates git hook to enforce Conventional Commits (#1041) * chore: Adds Conventional Commits commit-msg hook * docs: Adds section about git hooks in Contributing Guide & fixes the headers hierarchy
2020-12-01 16:38:45 +03:00
## 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
chore: Creates pre-commit hook to format Haskell code (#1047) * 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
2020-12-05 16:26:28 +03:00
sure you have run `./scripts/git-hooks/setup.sh` before you commit the first
time so that the hook is in place.
chore: Creates git hook to enforce Conventional Commits (#1041) * chore: Adds Conventional Commits commit-msg hook * docs: Adds section about git hooks in Contributing Guide & fixes the headers hierarchy
2020-12-01 16:38:45 +03:00
Language guide.
2017-06-26 12:45:18 +03:00
License
-------
docs: fix some typos and minor grammatical errors
2020-07-26 01:30:37 +03:00
Carp is currently released under the terms of the ASL 2.0 license.
Reference in New Issue Copy Permalink