When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Contributors should follow our code style and practices guide and new ingest functions should use our ingest function template. Suggested changes to the style guide should be discussed with the owners of the repository.
Please note we have a code of conduct; please follow it in all your interactions with the project.
Code should have unit test coverage. When adding code for a sensor, for example, unit tests for that sensor’s parsing code and at least one representative dataset should be included in the inst/example_data folder.
When writing unit tests for ingest functions, consider testing for these items in the resulting data frame.
You can also test that errors are thrown when headers are missing in data files, the data file does not appear to be in the correct format, etc.
If your commits will include R scripts, please run
devtools::check to check for common problems, run unit tests, and build Rd files. There should be no errors, warnings, or notes in the R CMD check results.
README.md is created from README.Rmd. To make edits to the readme, first edit README.Rmd and then knit that into README.md. For example, with README.Rmd open in RStudio, click the drop down arrow next to Knit and click Knit to github_document. You can ignore the pandoc error at the end of the output in the R Markdown window.
HTML documentation is built using pkgdown. If your commits affect documentation, which includes changes to README or CONTRIBUTING, please run
pkgdown::build_site(). See the wiki for information on pkgdown setup.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
Examples of unacceptable behavior by participants include:
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at firstname.lastname@example.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.