Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 3.03 KB
Raw

How to contribute?

👍🎉 First of all, thanks for your interest in improving the Galaxy Mentoring Network (GMN) platform! 🎉👍

You can make this project better by contributing to it. There are lots of ways to help out and become a GMN contributor, from creating more content to reporting mistakes and errors. Whatever is your background, there is a way to contribute: via the GitHub website, via command-line or even without dealing with GitHub.

We will address your issues and/or assess your change proposal as promptly as we can, and help you become a member of our community.

How can I report mistakes or errors?

The easiest way to start contributing is to file an issue to tell us about a problem such as a typo, spelling mistake, or a factual error. You can then introduce yourself and meet some of our community members.

How can I get started with contributing?

This repository store the sources for the website. You can help us improve it and get acknowledged for your contributions.

To make it easier to get started, we've compiled a list of some of the various ways you can help out. Please feel free to take a look through them, and see if any of them pique your interest:

  1. Create a new issue to suggest changes/improvements on our website/program.
  2. Send a pull request to correct typo, or fill any gap that you see on our website.

Do you have other ideas for contributions? Contact the coordinator (Berenice Batut).

How can I contribute in "advanced" mode?

Most of the content is written in GitHub Flavored Markdown with some metadata (a.k.a. front-matter) found in YAML files. Everything is stored on this GitHub repository.

To manage changes, we use GitHub flow based on Pull Requests:

  1. Create a fork of this repository on GitHub
  2. Clone your fork of this repository to create a local copy on your computer
  3. Create a new branch in your local copy for each significant change
  4. Commit the changes in that branch
  5. Push that branch to your fork on GitHub
  6. Submit a pull request from that branch to the master repository
  7. If you receive feedback, make changes in your local clone and push them to your branch on GitHub: the pull request will update automatically
  8. Pull requests will be merged by the training team members after at least one other person has reviewed the Pull request and approved it.

What can I do to help the project?

As we move forward with this project, you will find lists of issues to fix and features to implement. Feel free to work on them!

Note: The content of this file was highly inspired from the Open Life Science CONTRIBUTING.md file.