Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 3.74 KB

CONTRIBUTING.md

File metadata and controls

59 lines (36 loc) · 3.74 KB
Raw

Contributing Guide for the grazeR R Package

Please read our Code of Conduct before contributing to this project. We want to ensure a welcoming and inclusive environment for all contributors.

In this guide, you will get an overview of how to contribute to the grazeR R package. This guide is intended for both new and experienced contributors.

New Contributors

If you are new to contributing to open source, and not sure where to start, we recommend the following resources:

How to Contribute

We welcome all input and contributions to the grazeR R package. There are many ways to contribute to this project (not just code!), including:

  • Reporting bugs
  • Suggesting new features
  • Improving documentation
  • Fixing typos
  • Submitting code
  • Scientific validity of the methods

Please keep in mind that we are a small team of volunteers developing this R package. We will do our best to respond to your issue or pull request as soon as possible, but please be patient with us.

Getting Started

First, please read the README to familiarize yourself with the project. Then, please read the Code of Conduct to ensure a welcoming and inclusive environment for all contributors.

Reporting Bugs

If you find a bug, please report it by opening an issue. Please keep issues related to bugs, and use the Discussions for features and other discussions.

Please include the following information in your bug report:

  • The version of grazeR you are using
  • The version of R you are using
  • The operating system you are using
  • A minimal reproducible example of the bug

Suggesting New Features

If you have an idea for a new feature, please suggest it by posting to our Discussions. We will review your suggestions and determine if they are within the scope of the project. If so, we will add them to the project board.

Improving Documentation

Many of the features implemented in this package are not well documented. If you would like to help improve the documentation, please submit a pull request with your changes. We will review your changes and merge them into the project if they are helpful. We welcome reports of typos and other documentation errors as well. Additionally, reports of unclear documentation are also welcome.

Submitting Code

We conform to the tidyverse style guide. Please make sure your code conforms to this style guide before submitting a pull request. Please submit all code changes via a pull request. We will review your code and merge it into the project if it is helpful.

Scientific Validity of the Methods

We welcome feedback on the scientific validity of the methods implemented in this package. Many of these methods are based on our own research, but we are not experts in all of the methods implemented in this package. If you have feedback on the scientific validity of the methods, please submit an issue or pull request with your changes. We will review your changes and merge them into the project if they are helpful.