Skip to content
This repository has been archived by the owner on May 10, 2022. It is now read-only.

Latest commit

 

History

History
37 lines (24 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.84 KB

Thanks for your contribution!

Edit the task view:

Requirements:

If you don't want to or can't install these things, then just edit the pkgs.md file, and submit a pull request.

Steps

  1. Fork this repo

  2. Edit the pkgs.md file. If the package you are adding is on CRAN, add a the package name within <pkg></pkg> tags (use <ohat></ohat> for OmegaHat packages, <rforge></rforge> for RForge, and <bioc></bioc> for Bioconductor packages). If it's not on CRAN, put it within <a></a> tags (e.g., <a href="https://github.com/leeper/meme">meme</a> (not on CRAN)).

  3. On the command line type make and press enter, which creates the PackageDevelopment.ctv, PackageDevelopment.html, and README.md files.

  4. Check to make sure the .ctv file is correct. In the console output from make check, you should get:

    $`Packages in <info> but not in <packagelist>`
    character(0)
    
    $`Packages in <packagelist> but not in <info>`
    character(0)
    
    $`Packages in <packagelist> but not in repos`
    character(0)

    If you don't, follow the error messages to fix. If you can't figure out how to fix, just send the PR anyway, and the maintainer will fix.

    If you changed anything in the pkgs.md file, repeat step 3 to remake files. If everything was fine, proceed.

  5. Push back up to your account, then send a pull request to ropensci/PackageDevelopment

Submit an issue

If you just want to submit an issue, then go to the issues page and do that.