[DOC] Choose the package/namepace and functions naming conventions

[tbouffard]

package name

Initial proposal is bpmnVisualization in #21 --> we will keep this name (lowerCamelCase)

Resources

• https://www.alexandereckert.com/post/r-package-names/r-package-names/
• https://www.r-bloggers.com/2014/07/consistent-naming-conventions-in-r/: suggest underscore_separated with pros/cons

functions

we decide to use

• name: underscore_separated
• parameters: lowerCamelCase
• private function: prefixed by a dot i.e . (like Google R style)

Ressources

• https://google.github.io/styleguide/Rguide.html: BigCamelCase like DoSomething

[tbouffard]

We agreed on a conventions, so closing