Skip to contents

Contributing to Logger

Source: CONTRIBUTING.md

Thank you for your interest in contributing to Logger!

Code of Conduct

Please read and adhere to our Code of Conduct.

How to Contribute

  1. Report bugs or suggest enhancements by opening an issue.
    • Use a clear, descriptive title.
    • Provide detailed steps to reproduce or implement.
  2. Submit pull requests for bug fixes or new features.
    • Fill in the PR template.
    • Include tests and documentation.
  3. Improve documentation by submitting PRs for clarifications or additions.

Development Guidelines

  • Use 4 spaces for indentation.
  • Use box for imports.
  • Prefer base R functions and avoid unnecessary dependencies.
  • We aim to minimise external dependencies, including tidyverse packages.
  • Write clear, efficient, and maintainable code.

Example:

box::use(
    Logger[Logger, LogLevel]
)

log_message <- function(message, level = LogLevel$INFO) {
    logger <- Logger$new()
    logger$log(level, message)
}

Commit Messages

  • Use present tense (“Add feature”, not “Added feature”)
  • Be concise but descriptive

Need Help?

Check out issues labeled good first issue or help wanted.

Thank you for contributing to Logger!