Coding Standards

The following rules are meant to be enforced:

Coding Patterns:

Tippers and Bloaters should:

• both have examples which are also translated to tests automatically
• have a short description so it can be used in the GUI (A tipper that can't have a short description is probably not a good one)
• not use List functions, but use the implemented utilities instead
• follow the pattern of at least two parts - checking part and action part
• be implemented with a class inheriting from "abstractPattern"
• have robust tests

Warning Conventions:

• You should always fix all warnings before committing
• If you can't fix a warning because you don't know how - open an issue labeled as "unresolved-warning". opening an issue for such a warning is necessary because a lot of times warnings are just bugs that haven't appeared yet.
• If by any chance you pull a commit with warnings - please fix it before committing your other changes

Spartanizing Conventions:

• you should always spartanize your code before committing
• If by any chance you pull a commit which is not fully spartanized - please fix it before committing your other changes
• If a certain recommended tipper/bloater is advised but makes an error when chosen - open an issue labeled as "bug", because this project is responsible for all the spartanization and an un-functioning tipper is a project bug.

for other QA standards, please refer here