Contributing to Galaxy Training material
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?
- How can I contribute?
- How do I add new content?
- How is the training material maintained?
What should I know before I get started?
This repository is a project of unification of the Galaxy training material. You can find more information about this project in this small presentation
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, and help you become a member of our community.
If you have any questions, you can reach us using the Gitter chat.
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.
How is the training material maintained?
Each training topic and tutorial has one or two maintainers who 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. But they are not responsible for writing/keeping up-to-date training material content or deciding what lessons ought to exist, both will be coming from the community.
This repository is using the following labels for issues, pull requests and project management:
bug: errors to be fixed
improvement: enhancement to an existing functionality
feature: new functionality
discussion: discussion threads
question: often turn into discussion threads
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-toolsis used for questions/issues/pull requests related to the templates and tools rather than the lessons themselves.