.github/CONTRIBUTING.md

In OJWatson/rdhs: API Client and Dataset Management for the Demographic and Health Survey (DHS) Data

CONTRIBUTING

Fixing typos

Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file.

• YES: you edit a roxygen comment in a .R file below R/.
• NO: you edit an .Rd file below man/.

Prerequisites

Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it’s a problem. If you’ve found a bug, create an associated issue and illustrate the bug with a minimal reprex.

Pull request process

• We recommend that you create a Git branch for each pull request (PR).
• Look at the Travis build status before and after making changes. The README should contain badges for any continuous integration services used by the package.
• We recommend the tidyverse style guide. You can use the styler package to apply these styles, but please don't restyle code that has nothing to do with your PR.
• We use roxygen2.
• We use testthat. Contributions with test cases included are easier to accept.
• For user-facing changes, add a bullet to the top of NEWS.md below the current development version header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).

Writing tests that require downloading datasets

In order to check your contribution passes all tests, you will needt be able to run the full test suite. Instructions for how to do this can be found here.

Alternatively, you can use the package's CI with travis, to see if the test suite has passed. This test suite uses the encrypted "rdhs.json" config within the package root to download datasets. The datasets that are available to download with this config can be viewed within the "available_test_suite_datasets.csv".

If your contributions need access to a dataset that is not available, e.g. a new dataset that affects the flat file parsers, then open a PR and they will be requested from the DHS website.

Code of Conduct

Please note that the rdhs project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms. See rOpenSci contributing guide for further details.

Prefer to Email?

Email the person listed as maintainer in the DESCRIPTION file of this repo.

Though note that private discussions over email don't help others - of course email is totally warranted if it's a sensitive problem of any kind.

Thanks for contributing!

This contributing guide is adapted from the tidyverse contributing guide available at https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md

OJWatson/rdhs documentation built on April 4, 2024, 10:46 a.m.