File tree 2 files changed +19
-8
lines changed
2 files changed +19
-8
lines changed Original file line number Diff line number Diff line change 1
- # TODO
1
+ # Contributing
2
2
3
- Add basic guidelines here, things like style guide (using .configuration files from the repo) etc etc.
3
+ If you wish to contribute please see [ any issue on GitHub tagged with "help
4
+ wanted"] ( https://github.com/denibertovic/docker-hs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 ) .
5
+ Before starting to work, consider commenting on the issue you want to resolve or
6
+ open a new issue to discuss design decisions and implementation details. This is
7
+ so that no development cycles go to waste on implementing a feature that might
8
+ not get merged either because of implementation details or other reasons.
4
9
10
+ Make sure to submit your PR's against the ` master ` branch.
11
+
12
+ ## Project Setup
13
+
14
+ See the ` README.md ` file on how to setup the project on your development machine.
Original file line number Diff line number Diff line change @@ -14,16 +14,17 @@ Older docker version and engine api versions are not supported at the moment.
14
14
15
15
## Contributing
16
16
17
- If you wish to contribute please see any issue tagged with "help wanted".
18
- Make sure to submit your PR's against the ` master ` branch.
17
+ Please see [ CONTRIBUTING.md] ( CONTRIBUTING.md ) .
19
18
20
- Please consider filling an Issue first and discuss design decisions and implementation details before
21
- writing any code. This is so that no development cycles go to waste on implementing a feature that
22
- might not get merged either because of implementation details or other reasons.
19
+ ### Project Setup
23
20
21
+ For working on the library, you need the Haskell Tool Stack installed (see [ the
22
+ Haskell Tool Stack
23
+ website] ( https://docs.haskellstack.org/en/stable/install_and_upgrade/ ) ). You
24
+ also need ` make ` to use the ` Makefile ` included in the project. Run ` make help `
25
+ to see the available commands (for building, running the tests and releasing).
24
26
25
27
## IRC
26
28
27
29
If you have any questions or suggestions you can find the maintainers in ` #docker-haskell `
28
30
on freenode.
29
-
You can’t perform that action at this time.
0 commit comments