Skip to content

Latest commit

 

History

History
18 lines (11 loc) · 2.12 KB

contributing.md

File metadata and controls

18 lines (11 loc) · 2.12 KB

Contributing to ihmeuw-demographics repositories

The demographics team for the Global Burden of Disease Study at the Institute for Health Metrics and Evaluation is actively working on moving more code development to publicly available github repositories.

We encourage contributions of bug reports, feature requests, improved documentation, and software development. This can be in the form of creating a new Github issue, or making changes and submitting a pull request. Pull requests must be reviewed and approved by GBD demographics team members to ensure documentation, testing, code style, and other standards are met.

As this open source project is still in its infancy, documentation and testing has mainly been created and reviewed by GBD demographics team members, so we appreciate feedback in making this work more accessible to collaborators outside of IHME.

Contributing to R packages

The main repositories included in ihmeuw-demographics so far are R packages that implement our commonly used utility functions and methods. Prior to contributing to these R packages, collaborators should be familiar with the basic R package structure and standards as described in the packageTemplate wiki. We predominantly follow the guidelines outlined in the R packages book by Hadley Wickham.

The wiki reviews key points from the book plus highlights our standards and style including: