matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Rewrite contributing for less (boilerplate) text

Browse source
This commit is contained in:
Matthias Beyer 2019-12-07 19:07:38 +01:00
parent e2d006d563
commit 6a86a71b57
1 changed files with 13 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
doc/src/09010-contributing.md
View file

@ -6,19 +6,17 @@ All contributors agree to the
[developer certificate of origin](#developer-certificate-of-origin) [developer certificate of origin](#developer-certificate-of-origin)
by contributing to imag. by contributing to imag.
Feel free to contact [us via our mailinglist](http://imag-pim.org/mailinglist/) Feel free to contact [us via our mailinglist](http://imag-pim.org/mailinglist/)
and/or submit patches via mail (use `git format-patch` and and/or submit patches via mail (use `git format-patch` and
`git send-email`, always add a cover letter to describe your submission). `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 Make sure to test-compile your patchset and run tests if there are any for the
[a "Signed-off-by: " line](https://stackoverflow.com/questions/1962094/what-is-the-sign-off-feature-in-git-for). code you changed.
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.
## Prerequisites ## Prerequisites
@ -32,21 +30,6 @@ though you do not have to have the `nix` package manager installed to build
imag. imag.
Everything else will be done by `cargo`. 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 ## 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. free to send "Fixup" commits in the review process.
If squashing fails I will come back to you. If squashing fails I will come back to you.
We do not follow some official Rust styleguide for our codebase, but we try to Also ensure that each commit has
write minimal and readable code. 100 characters per line, avoid noise in the [a "Signed-off-by: " line](https://stackoverflow.com/questions/1962094/what-is-the-sign-off-feature-in-git-for).
codebase, ... you get it. 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 ## Code of Conduct