Persons contributing to this project agree to the code of conduct and agree to the potential redistribution of their code under our license.
The adopted contribution process requires that the collaborators fork the original repository and create pull requests for the changes to be approved by a team member. Here are some useful commands:
git clone git@github.com:YOUR-USERNAME/YOUR-FORKED-REPO.git
cd into/cloned/fork-repo
git remote add upstream git://github.com/ORIGINAL-DEV-USERNAME/REPO-YOU-FORKED-FROM.git
git fetch upstream
Updating your fork from original repo to keep up with their changes:
git
git fetch upstream
git checkout master
git merge upstream/master
After completing some tasks:
git add .
git commit -m '[COMMIT MESSAGE]'
git push
Wait for a member of the team to merge pull request.
Each group member is responsible to be:
**If a major change is made by any person, tag atleast two other contributors. If this change is approved by all → accept pull request.
We also use GitHub flow (fork) to manage changes:
git commit -m "A brief summary of the commit
A paragraph describing what changed and its impact."
git commit -m "Concise summary of what you did here"
testthat
to test our functions.codecov
will be used to test the coverage of all the tests written using testthat
.The following checks have to be implemented before submitting any major pull request to a stable version of the package:
devtools::check()
devtools::test()
covr::report()
goodpractice::gp()
devtools::spell_check()
R:
=
when assign objects. Instead, use ->
%>%
(including in dplyr package).R
file rather than .Rmd
or R notebook.This document was adapted from here.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.