Skip to content

Commit bd6388b

Browse files
committed
Added CONTRIBUTING.md guide
1 parent 36cf298 commit bd6388b

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

CONTRIBUITING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Building
2+
3+
The project is build with `cabal-install`. You might need to run `cabal
4+
update` after cloning the repository (to update [`Cardano Haskell
5+
Packages`][CHaP] (`ChaP`) index).
6+
7+
# Using in your project
8+
9+
Currently the package is published to [`CHaP`][CHaP]. In future it will be
10+
published to `Hackage`. If you want to pull it from [`CHaP`][CHaP], this is
11+
relatively easy to setup; for example, checkout the
12+
[`cabal.project`](https://github.com/input-output-hk/typed-protocols/blob/master/cabal.project)
13+
file. Alternatively, you can relay on `source-repository-package` stanza in
14+
a `cabal.project` file.
15+
16+
# Testing
17+
18+
The `typed-protocols-examples` package contains two simple protocols `PingPong`
19+
& `ReqResp` which are used for illustration & testing.
20+
21+
```
22+
cabal run typed-protocols-examples:test
23+
```
24+
25+
# Code Style
26+
27+
Please follow local style. For a more detailed style guide see
28+
[link](https://github.com/input-output-hk/ouroboros-network/blob/master/docs/StyleGuide.md).
29+
30+
# Pull Requests
31+
32+
Each commit shall be small and preferably address one thing at a time. Well
33+
organised & documented commits make it much easier for the maintainers to
34+
review them.
35+
36+
New features should be well documented & tested, which means including new
37+
tests as necessary. You might be asked by the maintainers to write & include
38+
additional tests.
39+
40+
Each commit should build & test, at least the package you are changing. You
41+
can update other packages from this repository in a subsequent commit.
42+
43+
Please use a draft PRs if the work is still in progress.
44+
45+
We require all commits to be signed, see [this guide][gh-signing-commits].
46+
47+
If your pull requests resolves an existing issue, please link your PR to that
48+
issue, see [GitHub documentation][gh-link-issue].
49+
50+
51+
[CHaP]: https://github.com/input-output-hk/cardano-haskell-packages/
52+
[gh-link-issue]: https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue
53+
[gh-signing-commits]: https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits

0 commit comments

Comments
 (0)