knitr::opts_chunk$set( collapse = TRUE, comment = "#>" )
Contributing to this package is very much welcome. This is an effort to
structure things and follow certain convention when pushing to Github
.
These keywords will be helpful when searching for relevant commits:
Feat:
for new feature or functionFix:
for bug fixDoc:
for documentation or changes to documentationClose:
or Style:
for changes to code or comments that aren’t because of bugsTest:
for code testing in tests
folderDEV:
for development processes for new featureVER:
for first version upgradeMisc:
for any changes that aren’t critical or doesn’t fit to any of the
above keywords. Avoid using it if possible or only as a last resort
Example of commit message
Feat: Get list of new files New files are missing in the current list. They need to be in the current list before aggregating.
Use message for commit as follows:
Keyword: Write summary as imperative or command More detail explanation if necessary with maximum 72 characters and use line break for long sentences.
The first line gives summary for what was done. Preferably to write this as
imperative mood or like commanding someone especially for commit related to
features, functions (Feat:)
or fixing code (Fix)
.
Where are the files located and how the files will be used.
/R
where all the R codes for the functions and objects for orgdata
live./inst
is for SQL code files and other files that are needed by the package./dev
is for other files that aren’t used in the package but good to
have as reference or code testing.utils-*
in folder /R
have helper functions that are used
multiple times in different places.Use these naming style:
snake_case
style is for function eg. find_column_input
camelCase
style is for object eg. fileGroup
kebab-case
style for filename eg. utils-internal.R
An effort to group functions according to their responsibilities
read_
perfix for major functions.do_
prefix for doing some action functions.get_
prefix for column specific functions.find_
prefix for helper functions.Files with is_
prefix for internal functions or utility to use orgdata
package.
Internal functions will not be exported but if needed, they can be accessed with
:::
eg. orgdata:::is_separate()
.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.