We welcome contributions to btw! This guide explains how to propose a change.
Code of Conduct
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.
Before you start
Always file an issue first. Before making any pull request, open an issue to discuss your proposed change. This helps ensure:
- Your work aligns with the project’s goals
- You’re not duplicating effort
- Maintainers can provide early feedback
You do not need to open an issue first for small and simple changes, like fixing typos.
Filing issues
When reporting a bug or suggesting a feature:
- Provide a clear description
- Include a minimal reproducible example for bugs – the reprex package is a great tool for this!
- Describe your environment (R version, OS, etc.)
- Be sure to provide as much detail as possible about which AI provider and model you are using
See our guide on how to create a great issue for more advice.
Making changes
- Fork the repository
- Create a branch off of
mainfor your work (don’t usemaindirectly!) - Make your changes following the tidyverse style guide
- Style your code with air
Before submitting a pull request
- Add tests for new functionality using testthat
- Update documentation with roxygen2 for user-facing changes
- Add a NEWS.md entry describing your change
-
Run
devtools::check()to ensure no errors, warnings, or notes - Keep commits clean with clear, descriptive messages