First of all, thanks for considering contributing to {opencage}! 👍 We welcome bug reports and pull requests that expand and improve the functionality of {opencage} from all contributors. This document outlines how to propose a change to {opencage}.
Please note that this project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.
There are several ways you can contribute to this project.
Think {opencage} is useful? Let others discover it, by telling them in person, via your preferred social medium, or a blog post. Please also share your use case in our discussion forum at discuss.ropensci.org.
Using {opencage} for a paper you are writing?
Please consider citing it.
Get citation information for {opencage} in R with citation(package = 'opencage')
.
Using {opencage} and got stuck? Browse the documentation to see if you can find a solution. Still stuck? Post your question on our discussion forum and tag it with the package name. While we cannot offer user support, we'll try to do our best to address it, as questions often lead to better documentation or the discovery of bugs.
Want to ask a question in private?
Email the person listed as maintainer in the DESCRIPTION
file of this repo.
Keep in mind that private discussions over email don't help others - but of course email is totally warranted if it's a sensitive problem of any kind.
Noticed a typo on the website? Think a function could use a better example? Good documentation makes all the difference, so your help to improve it is very welcome!
Small typos or grammatical errors in documentation can be edited directly using the GitHub web interface, as long as the changes are made in the source file.
This means you should
.R
file below R/
, not the .Rd
files below man/
.README.Rmd
file, not the README.md
file in the package root directory.Since we use a non-standard workflow to render the vignettes in this package, you should
*.Rmd.src
files in the vignettes/
directory, not the *.Rmd
files there.Using our_package and discovered a bug? That's annoying! Don't let others have the same experience and open an issue report on GitHub so we can fix it. Please illustrate the bug with a minimal working example, also known as a reprex, i.e. please provide detailed steps to reproduce the bug and any information that might be helpful in troubleshooting. The {reprex} 📦 can help you with this.
Care to fix bugs or implement new functionality for {opencage}? Awesome! 👏 Before you make a substantial change to the package, it is often preferable to first discuss need and scope for the change with the author(s) of the package in an issue report.
You should then follow the following process:
usethis::create_from_github("ropensci/opencage")
.
See the Pull Request Helper vignette for more details on how {usethis} can assist you with contributing code via pull requests (PR), .devtools::install_dev_deps()
, and then make sure the package passes R CMD check by running devtools::check()
.
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing. usethis::pr_init("brief-description-of-change")
.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]".NEWS.md
describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).You should also consider the following:
Check out our discussion forum if
{opencage} is licensed under the GPL-2 or later.
For more detailed info about contributing to rOpenSci, please see the rOpenSci Community Contributing Guide.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.