CONTRIBUTING.md

In devSJR/PCRedux: Quantitative Polymerase Chain Reaction (qPCR) Data Mining and Machine Learning Toolkit

How to contribute

You would like to contribute? We are happy to see you here.

Testing

PCRedux is tested with the testthat package. Please write new tests (where applicable) for any code you create.

Our package contains a lot of datasets that were used to test the package. However, qPCR amplification curves are highly diverse. This testing with your data is central to improve the quality of the software.

Submitting Changes

This is a volunteer-driven project, and that contributions are welcome.

Once you're ready to submit code, documentation or data, please create a pull request that clearly outlines the changes you've made. Additionally, when committing code please use clear commit messages describing the feature being committed. This helps keep track of changes to the project and makes reviews much easier!

The package used a MIT license.

Coding Conventions

• We use mainly underscore_separated code style
• The package is written in S3
• If you think the code isn't simple enough to understand alone, write comments!
• Please use the styler to improve the readbility of the code

Report issues or problems with the software

Report bugs and issues at https://github.com/PCRuniversum/PCRedux/issues

Before you submit a bug please look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Seek support & feature request

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.

Please interact via https://github.com/PCRuniversum/PCRedux/issues with us.

devSJR/PCRedux documentation built on Aug. 3, 2022, 1:34 p.m.