Skip to content
This repository was archived by the owner on Oct 19, 2024. It is now read-only.

Commit 76e930c

Browse files
authored
Suggestion for contributing guide (#281)
Fixes #279
1 parent b56357c commit 76e930c

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

DEVELOPMENT.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,23 @@ Most of our developers use using [Visual Studio Code](https://code.visualstudio.
55
- [Alejandro's post on setting up a Haskell development environment](https://www.47deg.com/blog/setting-up-haskell/), but forget about the Visual Studio Code configuration outlined there.
66
- [Kowainik's Haskell Style Guide](https://kowainik.github.io/posts/2019-02-06-style-guide).
77

8+
## Setting up the project
9+
10+
### Native dependencies
11+
12+
The included `adapter/kafka` project requires development headers of the rdkafka library:
13+
* on macOS `sudo brew install librdkafka`
14+
* on fedora `sudo dnf install librdkafka-devel`
15+
* on debian `sudo apt-get install librdkafka-dev`
16+
17+
### Git submodules
18+
19+
This project uses git submodules (notably for examples/library/). You can run `git submodule update --init --recursive` once after checkout, or `git config --global submodule.recurse true` to globally enable submodules.
20+
21+
### Integration tests
22+
23+
See also https://github.com/higherkindness/mu-scala-haskell-integration-tests
24+
825
## Visual Studio Code extensions
926

1027
To make our lives easier while developing in Haskell, we use a set of recommended extensions. The first time you open the project, the editor should suggest to install all those you do not have:

0 commit comments

Comments
 (0)