/AutoFlow-OmicsDataHandling

Big Data Omics handling for campaign and autonomous science

Primary LanguagePythonMIT LicenseMIT

BFAIR

Big and F.A.I.R. Omics Data.

Installation

TODO

Features

TODO

Examples

TODO

Contributing

We welcome all contributions. Please follow the guidelines below when contributing code.

Quick start

  1. Fork the repository
  2. Clone the repository
  3. Make a new branch from develop (see git model below) with your feature or fix
  4. Submita pull request

Git model

Please use the GitFlow model

Documentation

Please use the Numpy docstrings format

Commit messages

Please use the following standard for commit messages

  • fix: ... for all commits that deal with fixing an issue
  • feat: ... for all commits that deal with adding a new feature
  • tests:... for all commits that deal with unit testing
  • build:... for all commits that deal with the CI infrastructure and deployment

Pull requests

Please use the following PR title and description standards:

  • The PR title should be short and descriptive. Work in progress reviews should be titled as WIP:... and all other should follow the above for commit messages.
  • The PR description should describe 1) new features, 2) fixes, and 3) other changes

PR acceptance rules

In order to accept a PR, the following must be satisfied:

  1. All new functions and classes have corresponding unit tests
  2. All new functions and classes are documented using the correct style
  3. All unit tests, linting tests, and integration tests pass
  4. All new code is reviewed and approved by a repository maintainer