Skip to contents

Contributing to SVG

Source: CONTRIBUTING.md

Thank you for your interest in contributing to SVG! This document provides guidelines for contributing to this package.

Types of Contributions

Bug Reports

  • Use the GitHub Issues to report bugs
  • Include a minimal reproducible example
  • Include your R version and session info (sessionInfo())
  • Describe expected vs. actual behavior

Feature Requests

  • Open an issue describing the feature
  • Explain the use case and potential benefits
  • If possible, suggest an implementation approach

Code Contributions

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature)
  3. Make your changes
  4. Add tests for new functionality
  5. Ensure all tests pass (devtools::test())
  6. Update documentation if needed (devtools::document())
  7. Submit a pull request

Development Guidelines

Code Style

  • Follow the tidyverse style guide
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions focused and modular

Documentation

  • All exported functions must have roxygen2 documentation
  • Include @param, @return, @examples, and @export tags
  • Update vignettes if adding major features

Testing

  • Add tests for new functionality in tests/testthat/
  • Aim for high code coverage
  • Test edge cases and error conditions

Commit Messages

  • Use clear, descriptive commit messages
  • Reference issues when relevant (e.g., “Fixes #123”)

Code of Conduct

Please note that this project follows a Contributor Code of Conduct. By participating, you agree to abide by its terms.

Questions?

Feel free to open an issue or contact the maintainer at .