.github/CONTRIBUTING.md

In rstudio/connectapi: Utilities for Interacting with the 'Posit Connect' Server API

Contributing to connectapi

This outlines how to propose a change to connectapi. For more detailed info about contributing to this, and other tidyverse packages, please see the development contributing guide.

Testing

There are two test suites in the package. One contains unit tests and tests that use API mocks, so you can run them without access to a running Connect server. Run these as you would any other R test suite with devtools::test().

A second suite runs integration tests against a live Connect server running locally in Docker. This has some additional requirements.

• You need a valid Connect license key or file. Put the contents of the license key, or the path to the license file, in the RSC_LICENSE environment variable.
• You need Docker.
• If you're running on an ARM (non-Intel) Mac, export DOCKER_DEFAULT_PLATFORM=linux/amd64
• Run connectapi:::build_test_env() to set up the Connect processes in docker
• By default, this will run against a contemporary version of Connect. To test against an older version, set the environment variable CONNECT_VERSION to something else and then run build_test_env().
• Set CONNECTAPI_INTEGRATED=true in the environment to enable running the integration tests (they're skipped by default).
• Run them with source("tests/test-integrated.R")

Fixing 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. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed).

Pull request process

• Fork the package and clone onto your computer. If you haven't done this before, we recommend using usethis::create_from_github("rstudio/connectapi", fork = TRUE).

• 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). Follow the style described in https://style.tidyverse.org/news.html.

Code style

• New code should follow the tidyverse style guide. You can use the styler package to apply these styles, but please don't restyle code that has nothing to do with your PR.

• We use roxygen2, with Markdown syntax, for documentation.

• We use testthat for unit tests. Contributions with test cases included are easier to accept.

Code of Conduct

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

rstudio/connectapi documentation built on June 12, 2024, 5 a.m.