Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (34 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

47 lines (34 loc) · 1.89 KB

Contributing to this project

Requirements

This repo utilizes vagrant to test the install scripts. Please make sure you download the latest version of vagrant before contribulating to the project.

Steps

  1. Fork the repository on Github
  2. Create a named feature branch (like add_package_x_support)
  3. Write you change (see next section below)
  4. Write tests for your change (see next section below)
  5. Run the tests, ensuring they all pass
  6. Submit a Pull Request using Github

How to add system dependency support for an R package

  1. Create a directory with the same name as the r package you are adding support for. The directory MUST BE case sensitive.
mkdir packages/<r_package_name>
  1. Create a bash script in the directory named install and give it executable permissions
touch packages/<r_package_name>/install
chmod 755 packages/<r_package_name>/install

  1. Write your install bash script to install all the dependencies of your R package.

  2. Create a test.R file in the same directory.

touch packages/<r_package_name>/test.R

  1. Write this R script to install the R package and run some basic code to ensure that the package is installed correctly and functional.

  2. Test your install via running this command.

vagrant docker-run shinyapps-package-dependencies -- /vagrant/test <r_package_name>