This outlines how to propose a change to sx.
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). See our guide on how to create a great issue for more advice.
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("e-kotov/sx", fork = TRUE).Install all development dependencies with
devtools::install_dev_deps(), and then make sure the package passes R CMD check by runningdevtools::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 containFixes #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
We use Air to apply code styling (happens automatically on file save if you use Positron and should also happen automatically if you use other VSCode-compatible IDE, otherwise just run
air format <path-to-file>). Kindly, try not to restyle code that has nothing to do with your PR.We use roxygen2, with Markdown syntax, for documentation. We also try to reuse documentation as much as possible, so we use sx_params file and a helper in R/ to automate parameter documentation.
We use testthat for unit tests. Contributions with test cases included are easier to accept.
LLMs and coding agents
We use LLMs and coding agents to help us write and review code. We deposited relevant AGENTS.md file and symlinked it to be compatible with Claude Code, OpenCode, Gemini CLI, and Google Antigravity. Feel free to use these tools to help you contribute! Also feel free to contibute improvements to our agentic coding setup.