Thank you for your interest in contributing to brapiR2!
How to Contribute
- Fork the repository on GitHub
- Clone your fork locally
- Create a branch for your feature or fix
- Make your changes following the style guide below
-
Test your changes with
devtools::check() - Submit a pull request
Style Guide
- Follow the tidyverse style guide
- Use
roxygen2for documentation - All exported functions must have
@examples - Use
clifor user-facing messages (notmessage()orcat())
Adding a New BrAPI Endpoint
- Add the function in the appropriate module file (
R/core.R,R/germplasm.R, etc.) - Follow the existing pattern:
conas first argument,...for query params - Use
brapi_get()orbrapi_post_search()internally - Add the function to
NAMESPACEexports - Write tests in
tests/testthat/ - Update
NEWS.md
Reporting Issues
- Use the GitHub issue tracker
- Include a minimal reproducible example
- Note which BrAPI server you’re connecting to (if relevant)
Code of Conduct
Please be respectful and constructive. We follow the Contributor Covenant code of conduct.
