matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Add CONTRIBUTING.md file

Browse source
This commit is contained in:
Matthias Beyer 2016-01-17 19:34:48 +01:00
parent bec97f8fc2
commit 32f256a1d7
1 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,38 @@
# Contributing to imag
Prerequisites:
* cargo and rust compiler in current version (stable)
In particular, we seek the following types of contributions:
* Ideas: What is a PIM module you want to see implemented or (even better) could
you implement yourself?
* Testing: Feel free to test `imag`. Note that we have no release yet.
* Documentation: We want to have 100% documentation coverage. If you find
something undocumented or wrongly documented, don't hesitate to fix it and
send a PR!
# Commit guidelines, PR guidelines:
Please don't refer to issues or PRs from inside a commit message, if possible.
Make sure your PR does not contain "Fixup" commits when publishing it, but feel
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.
# Code of Conduct
We use the same
[code of conduct as the rust community does](https://www.rust-lang.org/conduct.html).
# Contact
Feel free to reach out via mail.
# FAQ
_to be written_