Legal info

Repository info


Med Associates

Guidelines for submission

To submit code, go to the appropriate forum on the discussions page. Before you submit code, please read and understand the license under which the code will be distributed.

To facilitate maintainability of code, we would like to standardize the way in which code is written. We therefore set up guidelines for code submission. If your code does not follow the guidelines, do not let that stop you from submitting the code. We need the programs! And since the programs are freely available, you can clean it up some other time, or perhaps someone else will do that for you. If you are a maintainer and would like to add guidelines, please send me an e-mail.
Not all guidelines are of equal importance. The first is essential for other people to be able to use your program. The second and third guidelines are important for other people to understand your code.

1. All inputs and outputs should be named using constants. For portability, it is important that the constant names used are standard. This allows for quick pasting of the common code (see above). If you require other constants, please drop us a line so that we can update this list. The standard labels allowed are:
Inputs: R1, R2, R3, R4, R5, LeftLever, LeftCheck, RightLever, RightCheck, Magazine, Motion
Outputs: S1, S2, S3, S4, S5, LeftExt, LeftLight, RightExt, RightLight, Feeder, CenterLight, HouseLight, Sonalert, Shock

2. All Z-pulses should be named using constants. See also point 1. For example:
    1": Z^ZStartSession ---> S2

3. Code should be indented. State sets and states are at the first level, Code is at the second, and IF statement redirections are at the fourth.