Skip to content

Code Requirements

Eric Swanson edited this page Apr 7, 2022 · 1 revision

Code comments are required for new features, toolboxes, and ongoing contributions. Use heading and inline comments to help guide readers through the workflow. For better readability, follow one commenting style throughout your code. The best way to write easily understandable comments is to imagine that someone who is new to the repository could follow along.

Where applicable list package requirements and dependencies.

Follow CIRN naming conventions.

Don’t include personal info like passwords and security keys/tokens explicitly in code. Use indirect function calls.

Clone this wiki locally