.github/CONTRIBUTING.md

In adithirgis/pollucheck: Explore Open-Source Air Pollution Data

Contributing to pollucheck

This outlines how to propose a change to pollucheck. For more detailed info about contributing to this, and other tidyverse packages, please see the development contributing guide.

Fixing typos

You can refer to this for proposing changes with pull request from a fork. You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file.

If you find any typos in an .Rd file, then please make changes in the corresponding .R file, as .Rd files are automatically generated by roxygen2 and should not be edited by hand.

Bigger changes

The first step here for you to make any changes is to install devtools using install.packages("devtools"). If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed).

Pull request process

• Fork the package and clone onto your computer. We recommend using usethis::create_from_github("adithirgis/pollucheck", fork = TRUE). For details on usethis click here.

• Install all development dependencies with devtools::install_dev_deps(), and then make sure the package passes R CMD check by running devtools::check(). It should pass without errors and warnings. If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.

• Create a git branch for your pull request (PR). We recommend using usethis::pr_init("brief-description-of-change").

• Make your changes, commit to git, and then create a PR by running usethis::pr_push(), and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain Fixes #issue-number.

• For user-facing changes, add a bullet to the top of NEWS.md (i.e. just below the first header). Follow the style described in https://style.tidyverse.org/news.html.

Code style

• New code should follow 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, with Markdown syntax, for documentation.

• We use testthat for unit tests. Contributions with test cases included are easier to accept.

Code of Conduct

Please note that the pollucheck project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.

adithirgis/pollucheck documentation built on Dec. 18, 2021, 10:28 p.m.