Skip to content

Commit

Permalink
migrate to the cloudyr project
Browse files Browse the repository at this point in the history
  • Loading branch information
leeper committed May 28, 2016
1 parent b5d0ccd commit 1938d74
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,11 @@ language: r
sudo: required
r_packages:
- covr
- drat
after_success:
- Rscript -e 'library("covr");codecov()'
- test $TRAVIS_PULL_REQUEST == "false" && test $TRAVIS_BRANCH == "master" && bash
drat.sh
env:
global:
secure: KGdWqq7NrikIkM/qchAtliqthtq+xAQVl1eHEm8KTJjEdB+B5ZeQZ9xgFhVwEgWq6zScxeflk1L1XxNL1WJysO7fzDaeSdLoDzyDNGZT8aXYNvmOF1oivVRipKE6gf3OVm4kUEyspMeIYRQBxEfGOeAdzWl7JJjXNQPhC4X080A=
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Contributions to **imguR** are welcome from anyone and are best sent as pull requests on [the GitHub repository](https://github.com/cloudyr/imguR/). This page provides some instructions to potential contributors about how to add to the package.

1. Contributions can be submitted as [a pull request](https://help.github.com/articles/creating-a-pull-request/) on GitHub by forking or cloning the [repo](https://github.com/cloudyr/imguR/), making changes and submitting the pull request.

2. The cloudyr project follows [a consistent style guide](http://cloudyr.github.io/styleguide/index.html) across all of its packages. Please refer to this when editing package code.

3. Pull requests should involve only one commit per substantive change. This means if you change multiple files (e.g., code and documentation), these changes should be committed together. If you don't know how to do this (e.g., you are making changes in the GitHub web interface) just submit anyway and the maintainer will clean things up.

4. All contributions must be submitted consistent with the package license ([GPL-3](http://www.gnu.org/licenses/old-licenses/gpl-3.0.en.html)).

5. Non-trivial contributions need to be noted in the `Authors@R` field in the [DESCRIPTION](https://github.com/cloudyr/imguR/blob/master/DESCRIPTION). Just follow the format of the existing entries to add your name (and, optionally, email address). Substantial contributions should also be noted in [`inst/CITATION`](https://github.com/cloudyr/imguR/blob/master/inst/CITATION).

6. The cloudyr project use royxgen code and documentation markup, so changes should be made to roxygen comments in the source code `.R` files. If changes are made, roxygen needs to be run. The easiest way to do this is a command line call to: `Rscript -e devtools::document()`. Please resolve any roxygen errors before submitting a pull request.

7. Please run `R CMD BUILD imguR` and `R CMD CHECK imguR_VERSION.tar.gz` before submitting the pull request to check for any errors.

Some specific types of changes that you might make are:

1. Bug fixes. Great!

2. Documentation-only changes (e.g., to Rd files, README, vignettes). This is great! All contributions are welcome.

3. New functionality. This is fine, but should be discussed on [the GitHub issues page](https://github.com/cloudyr/imguR/issues) before submitting a pull request.

3. Changes requiring a new package dependency should also be discussed on [the GitHub issues page](https://github.com/cloudyr/imguR/issues) before submitting a pull request.

4. Message translations. These are very appreciated! The format is a pain, but if you're doing this I'm assuming you're already familiar with it.

Any questions you have can be opened as GitHub issues or directed to thosjleeper (at) gmail.com.
23 changes: 23 additions & 0 deletions drat.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#!/bin/bash
set -o errexit -o nounset
addToDrat(){
mkdir drat; cd drat

## Set up Repo parameters
git init
git config user.name "leeper"
git config user.email "[email protected]"
git config --global push.default simple

## Get drat repo
git remote add upstream "https://$GH_TOKEN@github.com/cloudyr/cloudyr.github.io.git"
git fetch upstream
git checkout master

Rscript -e "drat::insertPackage('../$PKG_TARBALL', repodir = './drat')"
git add --all
git commit -m "add $PKG_TARBALL (build $TRAVIS_BUILD_ID)"
git push

}
addToDrat

0 comments on commit 1938d74

Please sign in to comment.