- Feedback: Please tell us what you thought of this module
- Found a problem? Report it!
- Continue to Module 9: Standards for Excellence in Bioinformatics Education & Training
Learning Objectives
- Describe what to include in a sharable code repository (README, LICENSE, citations)
- Explain version control basics and why releases/tags matter
- Identify best practices for dependency management and environment capture
- Recognize documentation and accessibility practices that improve reuse
Module Content
Complete the content below in order for better understanding and continuity of information.
Reading: Sharing Code for Reuse
Sharing Code for Reuse (placeholder)
Estimated time to complete: 5–15 minutes
Placeholder: Add any additional required readings (papers, tool docs, best-practice guides) described in the grant.
Activity: Set up your Space Ergonomically!
Sharing Code for Reuse (placeholder)
Estimated time to complete: 5–15 minutes
Placeholder: Add any additional required readings (papers, tool docs, best-practice guides) described in the grant.
Video: Code Sharing Workflows
Download Slides (opens in new tab) | Open directly in Yuja (opens in new tab)
Click to expand and watch video
Captions and transcript available within the player.
Estimated time to complete: 10–15 minutes
Placeholder: Replace links with the final slide deck folder and Yuja video.
Reflection: Making Your Code Usable by Others
Reflect on the following question(s) before moving on:
- What is the minimum you would need to add to a repository so someone else could run it?
- How would you help users install dependencies reliably (environment files, containers, or package managers)?
- What is one change you could make to improve readability (naming, comments, formatting, or tests)?
Estimated time to complete: 5–15 minutes
Placeholder: Add any required discussion prompts or mini-assignments described in the grant.
Practice Quiz
Estimated time to complete: 5–10 minutes
Placeholder: Link to your module practice quiz page when ready.
Downloads & Templates
- Slides folder / download link (placeholder)
- Handout / worksheet (placeholder)
- Activity files (datasets, starter code, or rubric) (placeholder)
Placeholder: Add any datasets, code templates, checklists, or rubrics promised in the grant.
Next Steps
Notes for Educators
You can use this content in your classes! This work is provided under a Creative Commons Attribution– Non Commercial (CC BY-NC) license. You can use, copy, share, or adapt this material for teaching, learning, or other non-commercial purposes.
You can pick and choose what you want from this website, or you can download the entire website's worth of content in ready-to-go Canvas format here: Download as a Canvas CourseWe do ask that you cite this work when you use it: Learn how.
Notes for Students
There's more on Canvas! Find more content and quizzes on the Canvas version of this course. Go back and click “Enroll in the Self-Paced Canvas Course” for more.