yfR
First, thanks for the interest in the package and apraisal for contributing to the codebase of `yfR.
While I am an academic, my R projects have no official funding. It is always nice to have the community helping maintaing the code. Here are the main links for contributing:
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
There are several ways you can contribute to this project. If you want to know more about why and how to contribute to open source projects like this one, see this Open Source Guide.
Think our_package is useful? Let others discover it, by telling them in person, via Twitter or a blog post.
Using our_package for a paper you are writing? Consider citing it.
If you've found a bug using the package, please report it by creating an issue on GitHub so we can fix it. A good bug report makes it easier for us to do so, so please include:
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!
This website is generated with pkgdown
. That means we don't have to write any html: content is pulled together from documentation in the code, vignettes, Markdown files, the package DESCRIPTION
and _pkgdown.yml
settings. If you know your way around pkgdown
, you can propose a file change to improve documentation. If not, report an issue and we can point you in the right direction.
Functions are described as comments near their code and translated to documentation using roxygen2
. If you want to improve a function description:
R/
directory in the code repository.#'
).Care to fix bugs or implement new functionality for our_package? Awesome! 👏 Have a look at the issue list and leave a comment on the things you want to work on. See also the development guidelines below.
We try to follow the GitHub flow for development.
git pull upstream master
..Rproj
).devtools::check()
and aim for 0 errors and warnings.Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.