Thank you for your interest in contributing to this project! All contributions are welcome, including bug reports, feature suggestions, documentation improvements, and code contributions.
How to Contribute
-
Reporting Bugs or Suggesting Features
- Before submitting a new bug or feature, please check the open issues to avoid duplicates.
- Use the provided issue templates for bug reports and feature requests.
-
Making Changes
- Fork the repository.
- Create a branch for your changes.
- Make your changes and ensure your code follows the project’s style guidelines.
- Test your changes and update documentation if needed.
- Commit your changes with a clear and descriptive message.
- Push your branch to your fork.
-
Open a pull request to the
main
branch.
-
Code Style
- Follow the tidyverse style guide for R code.
- Keep commits focused and concise.
-
Documentation
- Update documentation and examples if your changes affect usage.
-
Testing
- Ensure all tests pass before submitting a pull request.
- Add new tests for new features or bug fixes.
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.
Recognition
All contributors will be acknowledged in the NEWS file and, where appropriate, in the package documentation.
Questions
If you have any questions, feel free to open an issue or reach out via email.