Hello! The binding generator, which is the primary work done, is a complex piece of software. So, please follow these few rules in your PRs:
- Every method gets an at least short documetation. This includes
privatemethods. Only exception: Single-functionality classes. - Every class gets an at least short documetation string. No exceptions.
- Recycle code by refactoring if needed. Don't be over-DRY, but don't copy large swaths of code either.
- Text in comments get a double-space after each sentence:
Hello. Next sentence. - Comments and docs end on column 80 - Always. Try to keep code below 100 chars, up to 120 chars is acceptable.
- Feel free to add additional comments what the code is about to do, if it's not super obvious already.
- I'd rather have a method too much than too few: Keep the indention level low. A good candidate is splitting a method doing a complex operation over a list on each element.
For the C++ part of the project, additionally:
- Mimic the style already in-place around your code. That's it.