tricolore
This guide is adapted from the devtools
template
The goal of this guide is to help you contribute to tricolore
as quickly and as easily possible. The guide is divided into two main pieces:
Before you file an issue:
tricolore
. It's quite possible that the problem you're experiencing has already been fixed.tricolore
. Much functionality now lives in separate packages (e.g. ggtern
).When filing an issue, the most important thing is to include a minimal reproducible example so that we can quickly verify the problem, and then figure out how to fix it. There are three things you need to include to make your example reproducible: required packages, data, code.
dput()
to generate the R code to recreate it. For example, to recreate the mtcars
dataset in R, I'd perform the following steps:dput(mtcars)
in Rmtcars <-
then paste.
But even better is if you can create a data.frame()
with just a handful of rows and columns that still illustrates the problem.``` R
and ```
so it's syntax highlighted (which makes it easier to read).Your pull request will be easiest for us to read if you use a common style: http://r-pkgs.had.co.nz/r.html#style. Please pay particular attention to whitespace.
You should always add a bullet point to NEWS.md
motivating the change. It should look like "This is what changed (@yourusername, #issuenumber)". Please don't add headings like "bug fix" or "new features" - these are added during the release process.
If you propose a new feature, write a test for it.
If you're adding new parameters or a new function, you'll also need to document them with roxygen2. Make sure to re-run devtools::document()
on the code before submitting.
A pull request is a process, and unless you're a practised contributor it's unlikely that your pull request will be accepted as is. Typically the process looks like this:
You submit the pull request.
We review at a high-level and determine if this is something that we want to include in the package. If not, we'll close the pull request and suggest an alternative home for your code.
We'll take a closer look at the code and give you feedback.
You respond to our feedback, update the pull request and add a comment like "PTAL" (please take a look). Adding the comment is important, otherwise we don't get any notification that your pull request is ready for review.
Don't worry if your pull request isn't perfect. It's a learning process and we'll be happy to help you out.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.