USEPA / EPATADA

This R package can be used to compile and evaluate Water Quality Portal (WQP) data for samples collected from surface water monitoring sites on streams and lakes. It can be used to create applications that support water quality programs and help states, tribes, and other stakeholders efficiently analyze the data.
https://usepa.github.io/EPATADA/
Creative Commons Zero v1.0 Universal
40 stars 18 forks source link

Review and update contributing.rmd #129

Open cristinamullin opened 1 year ago

cristinamullin commented 1 year ago

Review and update contributing.rmd (https://github.com/USEPA/TADA/blob/develop/vignettes/CONTRIBUTING.Rmd)

See NASA example: https://github.com/nasa https://github.com/nasa/instructions/blob/master/docs/INSTRUCTIONS.md

https://opensource.guide/legal/#does-my-project-need-an-additional-contributor-agreement https://www.tidyverse.org/blog/2017/08/contributing/

See EPA guidance: https://www.epa.gov/webguide/github-guidance https://github.com/USEPA/open-source-projects/blob/master/license.md https://github.com/18F/18f.gsa.gov/blob/master/CONTRIBUTING.md#public-domain

See USGS examples: https://rconnect.usgs.gov/HASP_docs/articles/Contributing.html#references https://code.usgs.gov/water/stats/hasp/-/blob/main/vignettes/Contributing.Rmd?plain=1 https://rconnect.usgs.gov/dataRetrieval/articles/Contributing.html

codeboyfriend commented 1 year ago

Can I work on this

cristinamullin commented 1 year ago

Yes, please feel free to make edits and suggestions. Thanks!

codeboyfriend commented 1 year ago

ok

jbousquin commented 1 year ago

Noticed the link to the contributing markdown file (https://github.com/USEPA/TADA/blob/develop/CONTRIBUTING.md) is throwing a 404, when I submitted a PR it suggested the raw https://github.com/USEPA/TADA/blob/develop/docs/CONTRIBUTING.html, but I'm thinking route to the version in articles: https://usepa.github.io/TADA/articles/CONTRIBUTING.html

jbousquin commented 1 year ago

Something to consider for addition to contributing file is code style/linter. From tidyverse:

For tidyverse projects read the Style Guide and use the lintr package to find code which does not adhere to the style guide.

Right now lintr is catching mostly white space.