CONTRIBUTING.md

In richelbilderbeek/plinkr: Interface to PLINK

Contributing

Awesome that you are reading this.

This GitHub follows the Contributor Covenant Code of Conduct.

• For questions, you can create an Issue
• Code changes go via Pull Requests

Submitting use cases

Use cases of PLINK are welcomed.

Please send all that is needed to reproduce the use case:

• the input files
• the output files
• the arguments to call to PLINK
• (optional) how to do the same using plinkr

You can do so by:

• Add an Issue
• Send @richelbilderbeek an email (@richelbilderbeek will make an Issue of it)

Submitting code

Submitted code should follow these quality guidelines:

• All tests pass cleanly/silently
• Code coverage above 95%
• Coding style should follow the default style by lintr

These are all checked by GitHub Actions when submitting a Pull Request.

Emails with code will not be accepted.

Submitting bugs

Awesome. These are your options:

• Add an Issue, with the test that fails
• Submit a Pull Request, where the test is added to the tests/testthat folder
• Send @richelbilderbeek an email (@richelbilderbeek will make an Issue of it)

Pull Requests should follow the same guidelines as 'Submitting code'.

Branching policy

• The master branch should always build successfully
• The development branch is for developers

git usage

To get started working on plinkr do:

git clone https://github.com/richelbilderbeek/plinkr

Development is done on the develop branch. To download and checkout the develop branch, first go into the plinkr folder (cd plinkr), then do:

git checkout develop

Then the workflow is the common git workflow:

git pull
git add --all :/
git commit -m "Did something awesome"
git push

richelbilderbeek/plinkr documentation built on March 25, 2024, 3:18 p.m.