-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from katilingban/dev
refresh repository
- Loading branch information
Showing
70 changed files
with
516 additions
and
48,240 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,3 +12,6 @@ | |
^docs$ | ||
^netlify\.toml$ | ||
^CRAN-RELEASE$ | ||
^README\.Rmd$ | ||
^_pkgdown\.yml$ | ||
^pkgdown$ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
*.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,45 +1,35 @@ | ||
|
||
# Contributing | ||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue, | ||
email, or any other method with [Ernest Guevarra](mailto:ernest@validinternational.org) before making a change. | ||
|
||
Please note we have a [code of conduct](https://github.com/validmeasures/wash/blob/master/.github/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. | ||
|
||
<br/> | ||
|
||
## How to make a clean pull request | ||
|
||
* Create a personal fork of this project on Github. | ||
|
||
* Clone the fork on your local machine. Your remote repo on Github is called `origin`. | ||
|
||
* Add the original repository as a remote called `upstream`. | ||
|
||
* If you created your fork a while ago be sure to pull upstream changes into your local repository. | ||
|
||
* Create a new branch to work on! Branch from `development`. | ||
## Bugs | ||
|
||
* Implement/fix your feature, comment your code. | ||
* Submit an issue on the [issues page](https://github.com/katilingban/washdata/issues) | ||
|
||
* Follow the code style of the project, including indentation. | ||
## Code contributions | ||
|
||
* Add or change the documentation as needed. | ||
* Fork this repository to your Github account | ||
|
||
* Squash your commits into a single commit with git's [interactive rebase](https://help.github.com/articles/interactive-rebase). Create a new branch if necessary. | ||
* Clone your version on your account down to your machine from your account | ||
|
||
* Push your branch to your fork on Github, the remote `origin`. | ||
``` | ||
git clone https://github.com/<yourgithubusername>/washdata.git | ||
``` | ||
|
||
* From your fork open a pull request in the correct branch using the specified [Pull Request Template](https://github.com/validmeasures/wash/blob/master/.github/PULL_REQUEST_TEMPLATE.md). Target this project's `development` branch. | ||
* Make sure to track progress upstream i.e., on our version of `washdata` | ||
at `katilingban/washdata`, by doing | ||
|
||
* Update the `README.md` with details of changes to the interface particularly changes in how indicators are defined or addition of new indicators. | ||
``` | ||
git remote add upstream https://github.com/katilingban/washdata.git | ||
``` | ||
|
||
* Increase the version numbers in any examples files and the `README.md` to the new version that this `Pull Request` would represent. The versioning scheme we use is [SemVer](http://semver.org/). | ||
* Before making changes make sure to pull changes in from `upstream` by doing | ||
either `git fetch upstream` then merge later or `git pull upstream` to fetch | ||
and merge in one step | ||
|
||
* You may then request [Ernest Guevarra](mailto:ernest@validinternational.org) to merge your `Pull Request` for you. | ||
* Make your changes on a new feature branch | ||
|
||
* Once the pull request is approved and merged you can pull the changes from `upstream` to your local repo and delete | ||
your extra branch(es). | ||
* Please write a test or tests for your changes if they affect code and not just | ||
documentation | ||
|
||
* And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code. | ||
* Push up changes to your account | ||
|
||
* Submit a pull request at `katilingban/washdata` |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples | ||
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help | ||
on: | ||
push: | ||
branches: [main, master] | ||
pull_request: | ||
branches: [main, master] | ||
|
||
name: R-CMD-check | ||
|
||
jobs: | ||
R-CMD-check: | ||
runs-on: ${{ matrix.config.os }} | ||
|
||
name: ${{ matrix.config.os }} (${{ matrix.config.r }}) | ||
|
||
strategy: | ||
fail-fast: false | ||
matrix: | ||
config: | ||
- {os: macos-latest, r: 'release'} | ||
- {os: windows-latest, r: 'release'} | ||
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'} | ||
- {os: ubuntu-latest, r: 'release'} | ||
- {os: ubuntu-latest, r: 'oldrel-1'} | ||
|
||
env: | ||
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | ||
R_KEEP_PKG_SOURCE: yes | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- uses: r-lib/actions/setup-pandoc@v2 | ||
|
||
- uses: r-lib/actions/setup-r@v2 | ||
with: | ||
r-version: ${{ matrix.config.r }} | ||
http-user-agent: ${{ matrix.config.http-user-agent }} | ||
use-public-rspm: true | ||
|
||
- uses: r-lib/actions/setup-r-dependencies@v2 | ||
with: | ||
extra-packages: any::rcmdcheck | ||
needs: check | ||
|
||
- uses: r-lib/actions/check-r-package@v2 | ||
with: | ||
upload-snapshots: true | ||
build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples | ||
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help | ||
on: | ||
push: | ||
branches: [main, master] | ||
pull_request: | ||
branches: [main, master] | ||
release: | ||
types: [published] | ||
workflow_dispatch: | ||
|
||
name: pkgdown | ||
|
||
jobs: | ||
pkgdown: | ||
runs-on: ubuntu-latest | ||
# Only restrict concurrency for non-PR jobs | ||
concurrency: | ||
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} | ||
env: | ||
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | ||
permissions: | ||
contents: write | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- uses: r-lib/actions/setup-pandoc@v2 | ||
|
||
- uses: r-lib/actions/setup-r@v2 | ||
with: | ||
use-public-rspm: true | ||
|
||
- uses: r-lib/actions/setup-r-dependencies@v2 | ||
with: | ||
extra-packages: any::pkgdown, local::. | ||
needs: website | ||
|
||
- name: Build site | ||
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) | ||
shell: Rscript {0} | ||
|
||
- name: Deploy to GitHub pages 🚀 | ||
if: github.event_name != 'pull_request' | ||
uses: JamesIves/github-pages-deploy-action@v4.5.0 | ||
with: | ||
clean: false | ||
branch: gh-pages | ||
folder: docs |
Oops, something went wrong.