Skip to contents

Contributing to survinger

Source: CONTRIBUTING.md

Thank you for your interest in contributing to survinger! This document outlines how to propose changes and submit contributions.

Reporting Bugs

If you find a bug, please open an issue with a minimal reproducible example. The reprex package is the preferred way to create one. Include:

  • A brief description of the expected vs. actual behaviour
  • A reprex that demonstrates the problem
  • Output of sessionInfo() or devtools::session_info()

Suggesting Features

Feature requests are welcome. Please open an issue describing the use case and any alternatives you have considered.

Pull Requests

To contribute code:

  1. Fork the repository and create a new branch from main.
  2. If adding a new feature, include tests in tests/testthat/.
  3. Make sure devtools::check() passes with no errors or warnings.
  4. Use the tidyverse style guide. You can check your code with styler::style_pkg().
  5. Update documentation with devtools::document() if you change any roxygen comments.
  6. Submit a pull request describing the changes.

Code Style

This package follows the tidyverse style guide. Please use styler to format code and lintr to check for common issues.

Testing

All new functionality should be accompanied by testthat tests. Run the test suite with:

devtools::test()

Code of Conduct

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