Add contribution guide

NOTE This commit has been created by `git subtree` on the Mock Turtle repository on tag mock-turtle-2.0 This commit will not compile

Add contribution guide
NOTE This commit has been created by `git subtree` on the Mock Turtle repository on tag mock-turtle-2.0 This commit will not compile
13bbc54a · Federico Vaga · Federico Vaga · 73054260 · 13bbc54a
Commit 13bbc54a authored Jun 15, 2016 by Federico Vaga Committed by Federico Vaga Jun 15, 2016
Hide whitespace changes
Inline Side-by-side

Showing with 21 additions and 0 deletions

CONTRIBUTING.md CONTRIBUTING.md +21 -0

No files found.
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
+The project is based on the Mock Turtle infrastructure. On top of the
+Mock Turtle we have the White Rabbit Trigger Distribution.
+
+The project is made of:
+- two real-time applications running on the Mock Turtle CPUs
+- one library which provide the application's abstraction to communicate with
+  the real-time applications.
+- a set of command line tools for the White Rabbit Trigger Distribution
+  configuration
+
+
+RULES
+=====
+The master branch is protected so you need special permission to touch it.
+
+Do you development on your own branch and push it.
+
+In the project we are following the Linux kernel code style.
+
+All the functions, defines, structures, enumeraters exported should use
+the `wrtd_` prefix.