Contribution Guide

This page is meant to function as a set of general principles for the code that is contributed to the Network Canvas suite of apps (Network Canvas, Server, and Architect). These principles are designed to help us meet our overall goals: to have software that is easy to develop, easy to extend, and easy to debug.

Contributions from any team members are welcome, but please discuss your idea on Slack first!

General Principles

1. Code should be self-documenting, and as far as-is possible, self-explanatory.
2. Components should gracefully handle invalid/incorrect properties. Incorrect properties should not cause a component (or the app) to fail.
3. No speculative implementation. Not ever.
4. No committing to master. If you are under pressure, or need to fix something that quickly, something else has gone wrong in our process.