Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

54 lines (35 loc) · 2.31 KB
Raw

Contributing to the VIB training material

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to this training material on GitHub.

Table of contents

What should I know before I get started?

This repository is the VIB training material.

By contributing, you agree that we may redistribute your work under this repository's license.

We will address your issues and/or assess your change proposal as promptly as we can.

If you have any questions, you can reach us using at [email protected].

How can I contribute?

You can report mistakes or errors, create more contents, etc. Whatever is your background, there is probably a way to do it: via the GitHub website, via command-line. If you feel it is too much, you can even write it with any text editor and contact us: we will work together to integrate it.

You can contact us at [email protected] for more details.

How is the training material maintained?

Maintainers

Each training topic and tutorial has one or two maintainers who work at VIB Bioinformatics Core and act as editors.

They are responsible for making sure issues and change requests are looked at. They have the final say over what is included in the training material.

Labels

This repository is using the following labels for issues, pull requests and project management:

  • Type
    • bug: errors to be fixed
    • improvement: enhancement to an existing functionality
    • feature: new functionality
    • discussion: discussion threads
    • question: often turn into discussion threads
  • Status
    • help-wanted: requests for assistance
    • newcomer-friendly: suitable for people who want to start contributing
    • work-in-progress: someone is working on this
    • review-needed: requests for review
  • Topic: each topic has its own label to easily relate the issue or pull request to the topic, but the label template-and-tools is used for questions/issues/pull requests related to the templates and tools rather than the lessons themselves.