Giter VIP home page Giter VIP logo

bfair's Introduction

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

bfair's People

Contributors

teeradon-p avatar felixpacheco avatar dmccloskey avatar mmattano avatar ri-heme avatar michalmoravik avatar svevol avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.