Skip to contents

Contributing Guidelines for BGmisc

Source: CONTRIBUTING.md

Thank you for considering contributing to BGmisc. This document outlines the process and best practices for contributing to this R package hosted on GitHub under the R Computing Lab. ## Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. Bug Reports
  4. Feature Requests
  5. Pull Requests
  6. Code Style
  7. Testing
  8. Documentation
  9. Communication

Code of Conduct

All contributors are expected to adhere to the project’s Code of Conduct. Please read it carefully before contributing.

Getting Started

  1. Fork the BGmisc repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Install the required packages and set up the development environment.

Bug Reports

For reporting bugs, please create an issue in the GitHub repository. Make sure to:

  • Provide a clear title and description.
  • Include a minimal reproducible example.
  • Tag the issue with the “bug” label.

Feature Requests

New features are welcome. To request a new feature:

  • Open an issue in the GitHub repository.
  • Clearly describe the feature and its potential benefits.
  • Tag the issue with the “feature request” label.

Pull Requests

  1. Fork the repository and create a new branch for your work.
  2. Commit your changes in logical chunks.
  3. Open a pull request with a clear title and description.
  4. Make sure all existing tests pass.
  5. Add new tests for your changes.

Code Style

Follow the Tidyverse Style Guide for R programming to maintain code consistency.

Testing

  • Tests are implemented using the testthat package.
  • Make sure to add new tests for any added functionality.
  • Run all tests to ensure that they pass before submitting a pull request.

Documentation

  • Update the README.Rmd and other relevant documentation.
  • Use roxygen2 for documenting functions.
  • Include examples in the documentation where possible.

Communication

By contributing, you agree to abide by these guidelines and the project’s Code of Conduct.

Thank you for contributing to BGmisc!