galaxyproject / galaxyproject/training-material

Contribution ideas

Open
#2,070 15 comments 10 reactions 0 assignees View on GitHub
CoFest Hacktoberfest help-wanted newcomer-friendly paper-cut
Dominant language
HTML
Stars
367
Forks
1.1k
Avg merge
16h 27m
Merged PRs (30d)
49

Description

Looking for ideas for how to contribute to the [GTN](https://training.galaxyproject.org)? Below are some ideas to get you started:

**Tutorial testing** - work through a tutorial of your choice and let us know:
- did you run into any issues?
- spot any typos?
- did you want more scientific background information anywhere?
- did you have any other suggestions to improve the tutorial?
- If the tutorial did not provide a workflow, or if the workflow was out of date, extract the workflow from your history and add it to the GTN
- Feel free to make an issue with your thoughts, or a PR if you want to fix them yourself :)

**GTN Content**
1. Look through the [tutorial feedback](https://training.galaxyproject.org/feedback) we have received and make the suggested changes or address the comments (click on the tutorial names to see the detailed feedback and suggestions)
- When they've been resolved, let us know and we can hide those feedback as "resolved"

2. Give some love to one of the tutorials needing it (see https://github.com/galaxyproject/training-material/issues/807)

3. Add or update **speaker notes** of slides to make them suitable for automatic slide-to-video creation. instructions [here](https://training.galaxyproject.org/training-material/topics/contributing/tutorials/slides-with-video/tutorial.html)

4. Update the [Galaxy FAQs](https://galaxyproject.github.io/training-material/faqs/galaxy/) where needed. Are they up to date with the current Galaxy Interface? Do the instructions or screenshots need to be updated? Make a PR fixing them or an issue telling us they are out of date.

5. Have a look at any **issues** labelled ["help-wanted"](https://github.com/galaxyproject/training-material/labels/help-wanted), ["CoFest"](https://github.com/galaxyproject/training-material/labels/CoFest), ["newcomer-friendly"](https://github.com/galaxyproject/training-material/labels/newcomer-friendly), or ["Hacktoberfest"](https://github.com/galaxyproject/training-material/labels/hacktoberfest) or ["paper-cut"](https://github.com/galaxyproject/training-material/labels/paper-cut)

6. Record a video of you teaching one of the GTN tutorials. See our [FAQ](https://training.galaxyproject.org/training-material/faqs/gtn/recordings_create.html) for more information

**Reviewing**
1. Help us review [open pull requests](https://github.com/galaxyproject/training-material/pulls)!
- Can be on any level, from finding typos to testing the full tutorial and providing your feedback.
- You do not need to be an expert on the topic! It is also very valuable to have non-experts read or try the tutorial and let us know where things are unclear or more information is needed.
- Some info on adding your review in the GitHub interface [here](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests)

**Infrastructure**
1. Add tool versions to hands-on boxes so that they can be linked directly when using GTN from within Galaxy, instructions [here](https://training.galaxyproject.org/training-material/topics/contributing/tutorials/create-new-tutorial-content/tutorial.html#tool-links)
2. Add **workflow testing** to tutorial workflows, instructions [here](https://galaxyproject.github.io/training-material/topics/contributing/tutorials/create-new-tutorial-technical/tutorial.html#testing-the-workflow-recommended)

We will try to keep this issue up-to-date over time.

Please comment below if you would like to work on any of these issues, we are happy to help you get started! You can also reach us on our [Matrix channel](https://matrix.to/#/#Galaxy-Training-Network_Lobby:gitter.im) for help with this. Thanks for contributing!

Contributor guide

Open the contributing guide

Research direction

This is a menu of possible contributions rather than a single task, and it names no specific file or test. Start by choosing one bounded path, such as tutorial feedback, a labeled issue, speaker notes, or workflow testing, then read the linked instructions. Done should be one focused issue, review, or pull request with its changes or findings documented.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.