summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2016-01-17 19:34:48 +0100
committerMatthias Beyer <mail@beyermatthias.de>2016-01-22 19:45:27 +0100
commit32f256a1d7c6ca04278b7a17452ad105a715ef68 (patch)
tree9c82245d8d20265cc79c83f0dd9ce13976190c7f /CONTRIBUTING.md
parentbec97f8fc291780503fb009489dd47b586d0f395 (diff)
downloadimag-32f256a1d7c6ca04278b7a17452ad105a715ef68.tar.gz
imag-32f256a1d7c6ca04278b7a17452ad105a715ef68.tar.xz
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..38795528
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -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_
+