CONTRIBUTING.md
In cloudcell/rfintools: Utility Functions

RFC (Request for Comments)

This file is a work in progress. At the moment it serves as a place for piling up notes and ideas for R coding style in the financial sector, (not just for this particular repository). Github was chosen for this purpose because one can edit / contribute using only a web browser.

Contributing code with a test may increase the likelihood the code won't stay broken for years only to be thrown out as non-functional because nobody could detect it as such.
Do set up your own repository and use both Travis and Codecov.io to make sure your code runs in a clean environment and you didn't make any explicit blunders. Running tests with codecov() may sometimes be tricky if you aren't referencing environments carefully.
RUnit package is preferred, but testthat is ok. However, if the package you contribute to already has tests, use the existing testing package.

http://romantsegelskyi.github.io/blog/2015/11/16/good-practices-r-package/

Guidelines for making the file 'CONTRIBUTING(.md)' https://help.github.com/articles/setting-guidelines-for-repository-contributors/ https://github.com/blog/1184-contributing-guidelines * https://help.github.com/articles/setting-guidelines-for-repository-contributors/

Examples: Atom Puppet

Resources: Google style Hadley Wickham's guide derived from Google style a guide by csgillespie r-bloggers' guide #1 r-blogger's naming conventions by Derek Jones

Dot separation — “xyz.class” — shall be used only to demonstrate the class of an object (variable / function, etc.)
Dot underscore — “._xyz” — shall be used for internal to a function variables never to be used outside of the function
Dot underscore (times N, N>1) — “.xyz”, “._xyz” — shall be used in infrastructure code (akin to C reserved name conventions)
Names of constants shall be in CAPITAL_CASE with underscore(s).
Elsewhere “lowerCamelCase” shall be used (to be decided)
The dot sep (“xyz.nop.lovely.name”) might be popular because it is easy to type. However, it might only be restricted for field names in output tables: dot consumes less space compared to an underscore, so using a dot might make save screen space.

Type/State/Value testing functions value testing functions shall use 'dot.sep', i.e. obey the same convention as is.null(), is.na(), etc. type testing functions shall use 'dot.sep': is.*(), where * stands for a type/class, usually tested by 'inherits' within the body of the function.