Developer Resources

Git Branching Model

This project follows this development model of Git branching that you can find in details here.

This means that master branch always contains latest released version of toaster. New feature work belong to dedicated feature branch (one branch per feature) created off the develop branch. Please use Pull Request on feature branch to merge it into develop branch.

Branching and Pull Request with GitHub

• Using Pull Requests
• Forking a Repo
• Git fork vs. git clone
• Pull Request Tutorial
• How do a GitHub Pull Request
• Understanding the GitHub Flow

Coding Style

We follow Google's R Style Guide with exception of assignment operator - toaster prefers using of = instead of <- for variable assignment but keeps <- in function name assignment. One useful discussion with more links is here.

Source Code Files

Every compute function belongs to its own file. Sometimes such file contains a family of closely related compute functions (e.g. computeTfIdf.R). create (plotting) functions are placed together into files with many related functions. So far, there are 2 files plotting.R and plottingKmeans.R.

Writing Tests

Testing Guidelines and Examples