ENVI Contributor Guide

From OpenFlow Wiki

This guide is for those who are developing features for the base ENVI framework (if you just want to extend ENVI, look here).

Development E-mail List: http://yuba.stanford.edu/github/list.php?list=envi

Development: Stable Code and New Features

The master branch is the latest stable code. Bug fixes should be cherry-picked into this branch as soon as they are available. Each new feature will be developed in a new (temporary) branch. When the feature is stable, it should be merged into master and the temporary feature branch should be removed.

Coding Guidelines

• Don't use TAB characters
• Don't leave trailing whitespace
• Use this git filter to ensure TABs and trailing whitespace don't sneak into your code: coming soon
• Write javadocs
• Follow spacing and naming conventions in the existing code

Other Ideas (for the future)

• We may want to plan for a major release with several new features. In this case, we will add a devel branch. Each feature under development will be periodically merged into devel. Once the entire release is stable, then devel will be merged into master.
• Need to think about regression testing (automated)
• Separate repo envi-extensions for extensions? Make the base envi repo a submodule in that repo so master can still be easily merged into extensions?