If you want to contribute to the Tapshrooms Tap family, you'll have to conform to these standards.
Please note! These standards are viable to change at any given time, so
- Your Tap must have two classes,
PressureandTap. - Your
Tapwill have aPressureinstance available to it (preferably under the namepressure). - Your Tap and Pressure class will have all of the methods described in the example python file, and no more, unless requird (getters/setters, or other).
- Your Tap must come with a README, explaining usage.
- you should show how to compile the source, if needed
- you should briefly show example usage
- Your Tap class will use the output strings referenced below in the Strings section.
Your Tap must print these strings to standard output when applicable. Anything following a hash must not be included, and is simply there for explanation's sake.
- On initialisation:
I'm a tap!
- In the run() method:
I'm already running! # if the pressure is not zero
Catch me if you can! # if the tap starts running
- In the stop() method:
I'm not running! # if the pressure is zero
I've stopped! # if the tap has successfully stopped
- In the explode() method:
BANG! # when the pressure is more than the maximum, and the tap explodes