summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2016-08-24 17:11:16 +0200
committerMatthias Beyer <mail@beyermatthias.de>2016-08-24 17:11:16 +0200
commit15e43ee0bc0c3cce283b8c196a996c627a65f1b7 (patch)
tree2a15dbfe502217d02ed9c7b14123d7419317a95e /CONTRIBUTING.md
parent5517468e4d4cb5334b672e7cc121eb753e61f785 (diff)
downloadimag-15e43ee0bc0c3cce283b8c196a996c627a65f1b7.tar.gz
imag-15e43ee0bc0c3cce283b8c196a996c627a65f1b7.tar.xz
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md22
1 files changed, 14 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index aa69f91b..f192837b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -43,10 +43,15 @@ file issues about them or even better: Write a pull request to fix them!
* cargo and rust compiler in current version (stable)
-That's it so far, you don't need no additional dependencies. Note that this
-software is targeted towards commandline linux users and we do not aim to be
-portable to Windows or Mac OSX (though I wouldn't mind merging patches for OS X
-compatibility).
+Dependencies are listed in the [default.nix
+file](http://git.imag-pim.org/imag/tree/default.nix),
+though you do not have to have `nix` installed to build imag.
+
+`make` (better: `gnu make`) can be helpful to automate the build process.
+
+Note that this software is targeted towards commandline linux users and we do
+not aim to be portable to Windows or Mac OSX (though I wouldn't mind merging
+patches for OS X compatibility).
* If you want to build the documentation (you don't have to)
* pandoc
@@ -77,9 +82,9 @@ Not all of your commits have to be buildable. But your PR has to be.
## PR guidelines:
We'd like to have one PR per module change. This means you _should_ only change
-one imag module in one commit (library plus belonging binary is okay). As this
-is not always possible, we do not enforce this, though we might ask you to split
-your PR into two smaller ones.
+one imag module in one commit or PR (library plus belonging binary is okay).
+As this is not always possible, we do not enforce this, though we might ask you
+to split your commits/PR into two smaller ones.
Use feature branches. If you could name them "<module name>/<what you do>",
for example "libimagstore/add-debugging-calls", that would be awesome.
@@ -117,7 +122,8 @@ ask questions as well!
## Contact
-Feel free to reach out via mail.
+Feel free to reach out via mail/[mailinglist](http://imag-pim.org/mailinglist/)
+or [IRC](irc://irc.freenode.net/#imag).
## More information about the structure of this project