Add short hacking guidance
[profile/ivi/ofono-qt.git] / HACKING
1 The basic rule is simple: follow the coding style, and the design and functionality
2 patterns that are already there. There are patterns for getting and setting oFono 
3 properties, calling methods and getting the method call result, setting the errors,
4 and receiving out-of-band signals. Hopefully that should be enough for any remaining 
5 APIs which are currently missing.
6
7 For any new API that is added, there should also be a test case. Again, try to
8 imitate existing test cases. It is not necessary to thoroughly test the functionality;
9 it is enough to go through all properties, methods and signals and check that they
10 work, return sane values and match the actual oFono API. The tests should be 
11 written against Phonesim phone simulator and they should be able to run without 
12 manual intervention.