Contributing

Suggesting new features

You can request new features by opening an issue on GitHub. Even if you don’t feel up to coding this new feature, feel free to engage or participate in discussions in each package repository (Table 1).

Table 1: Code repositories of the tesselle packages.

Package	Repository
aion	tesselle/aion
alkahest	tesselle/alkahest
ananke	tesselle/ananke
arkhe	tesselle/arkhe
dimensio	tesselle/dimensio
folio	tesselle/folio
isopleuros	tesselle/isopleuros
kairos	tesselle/kairos
khroma	tesselle/khroma
kinesis	tesselle/kinesis
nexus	tesselle/nexus
tabula	tesselle/tabula
tesselle	tesselle/tesselle

Issues

Create a new issue

If you’ve found a bug, search if an issue already exists in the relevant repository. If a related issue doesn’t exist, please file an issue that illustrates the bug with a minimal reprex.

Solve an issue

Open issues are listed on the project dashboard.

You can find beginner-friendly issues in code repositories by visiting github.com/tesselle/<repository>/contribute.

Fix typos

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This generally means you’ll need to edit roxygen2 comments in an .R, not a .Rd file. You can find the .R file that generates the .Rd by reading the comment in the first line.

Bigger changes

If you want to make a bigger change, it’s a good idea to first file an issue and make sure someone from the team agrees that it’s needed.

Pull request process

• Fork the package and clone onto your computer. If you haven’t done this before, we recommend reading Jenny Bryan’s Happy Git and GitHub for the useR first.
• Install all development dependencies with 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.
• Create a Git branch for your pull request (PR). We recommend using usethis::pr_init("brief-description-of-change").
• Make your changes, commit to git, and then create a PR by running 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.
• For user-facing changes, add a bullet to the top of NEWS.md (i.e. just below the first header).

Code style

• New code should follow the style guide.
• We use roxygen2, with Markdown syntax, for documentation.
• We use tinytest and tinysnapshot for unit tests. Contributions with test cases included are easier to accept.

Code of Conduct

Please note that the tesselle project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.

Attribution

This contributing guide is adapted from the tidyverse contributing guide.