Contributing Guide

Thank you for your interest in contributing to this project! We welcome all contributions, whether it's reporting issues, suggesting improvements, or submitting pull requests.

Style Guide

• R code:
  • Follow the tidyverse style guide, or at least be consistent on your coding.
  • Use the styler package to automatically format code.
  • Use usethis for package setup and workflow helpers.
• Documentation:
  • Write clear, concise documentation and comments.
  • Use roxygen2 for documenting R functions.

Searching for Issues

• Before opening a new issue, please search existing issues to see if your question or bug has already been reported.
• If you find a related issue, feel free to add a comment or reaction.

Submitting Issues

• Provide a clear and descriptive title.
• Include steps to reproduce the problem, expected behavior, and actual behavior.
• If relevant, include code snippets or screenshots.
• For feature requests, explain your use case and why it would be helpful.

Submitting Pull Requests

• Web version (GitHub UI):

  1. Fork the repository and create a new branch for your changes.
  2. Make your edits directly in the browser.
  3. Open a pull request with a clear description of your changes.

• Git basics (optional):

  • Clone your fork: git clone https://github.com/your-username/<repository-name>.git
  • Create a branch: git checkout -b my-feature
  • Commit and push your changes: git add . git commit -m "Describe your change" git push origin my-feature
  • Open a pull request from your branch.

• Ensure your code passes all checks and tests.

• Reference related issues in your pull request description (e.g., "Closes #123").