Contribution Guide

Ref:

• CONTRIBUTION.md example
• Google Enginnering Practices - How to do a code review
• PEP 350 - Codetags
• what is the meaning of xxx in code comment
• Using TODO Comment

Code Review replies:

• LGTM: Look Good To Me (approve the request)
• PTAL: Please Take A Look (request for review)
• CL: Change List

Comment Code Tags:

• NOTE: Description of how the code works
• HACK:FIXME:/HACK: Not very well written or malformed code to circumvent a problem/bug.
• XXX/NOTE:XXX:: Warning about possible pitfalls.
• FIXME: This works, sort of, but it could be done better. (usually code written in a hurry that needs rewriting).
• BUG: There is problem here
• TODO: No problem, but addtional code needs to be written, usually when you are skipping something.
• DOING: Code is not completed yet