Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 2.06 KB
Raw

Introduction

Hi there, thank you for considering contributing to GPSeq-RadiCal to help us make our code a better version of itself!

GPSeq-RadiCal is an open source project, and as such any kind of contribution is welcome! There are many ways to contribute, from improving the code, the documentation, submitting bug reports, requesting new features or writing tutorials or blog posts.

Ground Rules

To see what kinds of behaviour are ucceptable when contributing to GPSeq-RadiCal, please refer to our code of conduct.

Getting started

We host GPSeq-RadiCal on GitHub, where we also track issues and feature requests, as well as accept pull requests.

Please, note that any contributions you make will be under the MIT Software License. In other words, all your submissions are understood to be under the same MIT License that covers the GPSeq-RadiCal project. Feel free to contact us if that's a concern.

How to submit a contribution

To process code change, we follow the Github Flow. All code changes to our master branch happen through pull requests. We actively welcome your pull requests!

How to report a bug

If you want to reporte a bug, please use the GitHub issue tracker and follow the issue template that should automatically load up.

How to suggest a feature or enhancement

If you would like to see a new feature implemented in GPSeq-RadiCal, or to have an already existing feature improved, please use the GitHub issue tracker and follow the template that should automatically load up.

Style your contributions

We like to have GPSeq-RadiCal code styled according to the following style guides.

  • We use Lintr to test the style of our code.
  • Line length should be 80 or less characters.
  • Refrain from using library, require, source.

Use the provided gpseq-radical-lint.R script to validate your code changes.