summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2019-12-07 19:07:38 +0100
committerMatthias Beyer <mail@beyermatthias.de>2019-12-08 14:28:58 +0100
commit6a86a71b57adfb2511a4b28c4db8125ce1a87ba6 (patch)
treeec6763135e7942d05baccd742fd558dd6fa677e0
parente2d006d5639bc6ca39401f93ea21380aca1d6f86 (diff)
Rewrite contributing for less (boilerplate) text
-rw-r--r--doc/src/09010-contributing.md40
1 files changed, 13 insertions, 27 deletions
diff --git a/doc/src/09010-contributing.md b/doc/src/09010-contributing.md
index a86ae2e9..81dce995 100644
--- a/doc/src/09010-contributing.md
+++ b/doc/src/09010-contributing.md
@@ -6,19 +6,17 @@ All contributors agree to the
[developer certificate of origin](#developer-certificate-of-origin)
by contributing to imag.
-
Feel free to contact [us via our mailinglist](http://imag-pim.org/mailinglist/)
and/or submit patches via mail (use `git format-patch` and
`git send-email`, always add a cover letter to describe your submission).
+You don't have to send patches via mail, though. As long as I can `git pull`
+your changes (without having to login or register at the remote) or `git am`
+your patchset, I'm fine.
+I'd encourage you, though, to [use git-send-email](https://git-send-email.io)
+or at least [git-request-pull](https://git-scm.org/)
-Also ensure that each commit submitted via email has
-[a "Signed-off-by: " line](https://stackoverflow.com/questions/1962094/what-is-the-sign-off-feature-in-git-for).
-By adding that line, you agree to our
-[developer certificate of origin](#developer-certificate-of-origin).
-If you do not add the "Signed-off-by: " line, I reserve the right to kindly
-reject your patch.
-
-Make sure to test-compile your patchset and, if available, run tests.
+Make sure to test-compile your patchset and run tests if there are any for the
+code you changed.
## Prerequisites
@@ -32,21 +30,6 @@ though you do not have to have the `nix` package manager installed to build
imag.
Everything else will be done by `cargo`.
-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) you'll need:
-
-* pandoc
-* pandoc-citeproc
-* texlive
-* lmodern (font package)
-* (gnu) make
-
-All dependencies are installable with the nix package manager by using a
-`nix-shell`, if you have the nix package manager installed on your system.
-
## Commit guidelines
@@ -54,9 +37,12 @@ Make sure your patchset does not contain "Fixup" commits when publishing it, but
free to send "Fixup" commits in the review process.
If squashing fails I will come back to you.
-We do not follow some official Rust styleguide for our codebase, but we try to
-write minimal and readable code. 100 characters per line, avoid noise in the
-codebase, ... you get it.
+Also ensure that each commit has
+[a "Signed-off-by: " line](https://stackoverflow.com/questions/1962094/what-is-the-sign-off-feature-in-git-for).
+By adding that line, you agree to our
+[developer certificate of origin](#developer-certificate-of-origin).
+If you do not add the "Signed-off-by: " line, I reserve the right to kindly
+reject your patch.
## Code of Conduct