.github/CONTRIBUTING.md
In lockedata/HIBPwned: Bindings for the 'HaveIBeenPwned.com' Data Breach API
Contributing guide
Code of Conduct
Anyone getting involved in this package agrees to our Code of Conduct. If someone is breaking the Will Wheaton rule aka Don't be a dick, or breaking the Code of Conduct, please let me know at steph@itsalocke.com or keybase.io/stephlocke.
Bug reports
When you file a bug report, please spend some time making it easy for us to follow and reproduce. The more time you spend on making the bug report coherent, the more time we can dedicate to investigate the bug as opposed to the bug report. We recommend using reprex when providing minimal examples.
If you need a secure way to communicate with the maintainer of this package, message her via her Keybase account.
Ideas
Got an idea for how we can improve the package? Awesome stuff!
Please raise it in the issue tracker with some succinct information on expected behaviour of the enhancement and why you think it'll improve the package.
Package development
We really want people to contribute to the package. A great way to start doing this is to look at the help wanted issues and/or contribute an example.
Conventions
We're relatively loose on coding conventions.
- Datasets are lower-case with underscores between words
- R code should be formatted with the "Reformat code" option in RStudio
- There are no standards for base R plots
- My preferred ggplot2 themes are
theme_minimal where axes labels matter and theme_void when they do not but I'm OK with the default ggplot2 theming if you want to avoid writing longer ggplot2 code.
New features should be accompanied by new unit tests. We're glad to help with that if you're new to testing!
lockedata/HIBPwned documentation built on Oct. 15, 2022, 12:19 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Contributing guide
Code of Conduct
Anyone getting involved in this package agrees to our Code of Conduct. If someone is breaking the Will Wheaton rule aka Don't be a dick, or breaking the Code of Conduct, please let me know at steph@itsalocke.com or keybase.io/stephlocke.
Bug reports
When you file a bug report, please spend some time making it easy for us to follow and reproduce. The more time you spend on making the bug report coherent, the more time we can dedicate to investigate the bug as opposed to the bug report. We recommend using reprex when providing minimal examples.
If you need a secure way to communicate with the maintainer of this package, message her via her Keybase account.
Ideas
Got an idea for how we can improve the package? Awesome stuff!
Please raise it in the issue tracker with some succinct information on expected behaviour of the enhancement and why you think it'll improve the package.
Package development
We really want people to contribute to the package. A great way to start doing this is to look at the help wanted issues and/or contribute an example.
Conventions
We're relatively loose on coding conventions.
- Datasets are lower-case with underscores between words
- R code should be formatted with the "Reformat code" option in RStudio
- There are no standards for base R plots
- My preferred ggplot2 themes are
theme_minimalwhere axes labels matter andtheme_voidwhen they do not but I'm OK with the default ggplot2 theming if you want to avoid writing longer ggplot2 code.
New features should be accompanied by new unit tests. We're glad to help with that if you're new to testing!
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.