summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2017-04-22 11:51:09 +0200
committerMatthias Beyer <mail@beyermatthias.de>2017-05-03 10:49:38 +0200
commit525491e21fe937768db3d2f6bee44ec4b66704bd (patch)
tree91f2e64c2b3b609da8281e0dbe726ef2201a3960 /CONTRIBUTING.md
parent1c0c9ff3780d9adaa034e4c3de460a8184d2bc1b (diff)
downloadimag-525491e21fe937768db3d2f6bee44ec4b66704bd.tar.gz
imag-525491e21fe937768db3d2f6bee44ec4b66704bd.tar.xz
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md25
1 files changed, 13 insertions, 12 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f192837b..3f4615d9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,18 +1,18 @@
# Contributing to imag
-So you want to contribute to imag! Thank you, that's awesome of you!
+So you want to contribute to imag! Thank you, that's awesome!
If you already have something in mind, go ahead with [the prerequisites
section](#prerequisites). If you don't know what you could do, start here.
-All contribors agree to the
+All contributors agree to the
[developer certificate of origin](#developer-certificate-of-origin)
by contributing to imag.
## Without Github
-If you do not want to use github for your contribution, this is completely okay
-with us. Feel free to contact [us via our mailinglist](http://imag-pim.org/mailinglist/)
+If you do not want to use github for your contribution, this is completely okay.
+Feel free to contact [us via our mailinglist](http://imag-pim.org/mailinglist/)
via mail, feel also free to submit patches via mail (use `git format-patch` and
`git send-email`, always add a cover letter to describe your submission).
@@ -25,7 +25,7 @@ Once _I am_ okay with your patchset, I will
submit it as PR in the github repository, so more people can review it and CI
can test it (the mailinglist is not yet used as much as github). I might come
back to you if something broke in CI or someone has a suggestion how to improve
-your PR. I will keep you as author of the commits.
+your PR. I will keep you as author of the commits.
The following sections describe the way how to contribute with github.
@@ -42,12 +42,13 @@ file issues about them or even better: Write a pull request to fix them!
## Prerequisites
* cargo and rust compiler in current version (stable)
+* Ruby and Bundler if you want to write a Ruby module.
-Dependencies are listed in the [default.nix
-file](http://git.imag-pim.org/imag/tree/default.nix),
+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.
+`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
@@ -71,15 +72,15 @@ free to push "Fixup" commits in the review process. We will ask you to clean
your history before merging!
Make sure to prefix your commits with `"doc: "` if you change the document. Do
-not change document and code in one commit, always seperate them.
+not change document and code in one commit, always separate them.
-We do not follow some official rust styleguide for our codebase, but we try to
+We do not follow some official Rust styleguide for our codebase, but we try to
write minimal and readable code. 100 characters per line, as few lines as
possible, avoid noise in the codebase, ... you get it.
Not all of your commits have to be buildable. But your PR has to be.
-## PR guidelines:
+## PR guidelines
We'd like to have one PR per module change. This means you _should_ only change
one imag module in one commit or PR (library plus belonging binary is okay).
@@ -101,7 +102,7 @@ If you're writing an application or module for imag, feel free to propose
integrating it into the imag core distribution, if it fulfills the following
requirements:
-1. It is written in Rust
+1. It is written in Rust or Ruby
1. It has a commandline interface which is the main interface to the module
OR it is a utility library for creating new kinds of functionality within the
imag core.