All forms of contribution to xrf are greatly appreciated:
- feature additions
- bug fixes
- optimizations
- documentation
- vignettes
- anything else you can think of
Your interest in the project fuels mine, so please do not hesitate to reach out with proposals. Please propose your changes via:
- Filing a github issue
- Emailing me (karljholub at gmail.com)
Ideally, changes are made according to the following process:
- Fork the repository
- Make your changes
- Ensure that xrf tests succeed (run via
devtools::test()) - Submit a pull request (this can be done via github UI)
- Maintainers will provide a code review. Every substantive comment must be addressed before the PR is accepted.
- Please bump version numbers (
major.minor.patch) inDESCRIPTIONaccording to the final change made- major number for any substantial API or backwards incompatible changes
- minor number for any standard change not touching API or compatibility
- patch number for any bug fixes
We are informally using tidy code style via the air formatter.
Please install air and run with air format . after making changes.
If you're new to R package development but want to develop on xrf, both of the following are great resources:
- Wickham's R packages book
- The devtools package
Also feel free to open a correspondence with me (karljholub at gmail.com).