CONTRIBUTING.md

In klmr/modules: Modules for R

Contribution guidelines

We’ll keep this simple:

Code …

… submissions

Please make all your pull requests against the develop branch (this is the default branch). No other pull requests will be accepted. In particular, master is a release branch and is destructively overwritten by automatic processes.

Ensure all tests pass by running make test, and ideally R CMD check.

All new functions, also unexported ones, must be documented.

… style

• Don’t use dots (.) in identifiers, except for S3 dispatch; use underscore (_) to separate words.
• Never "string-quote" identifiers; when using invalid identifiers, use `backtick quotes` instead.
• Use = assignments, not <-.
• Indentation is by four spaces.
• R files must end in .r — no capital letters in file extensions, please.
• Don’t waste vertical space: use empty lines judiciously; don’t put opening braces on their own lines, and keep individual functions at a reasonable maximum length.
• Generally try to be consistent with the prevailing style in this project.

… of conduct

Be polite, use common sense. Assume good faith in others. If you’re unsure, please refer to the Contributor Covenant Code of Conduct.

klmr/modules documentation built on Feb. 3, 2021, 3:24 a.m.