What is code sharing and co-developing?
Code sharing involves making your code publicly available, which increases the chances of others using it and lowers barriers for contributions and collaborations. It also promotes transparency, which is essential for research reproducibility and repeatability. Co-developing refers to collaborating with others on code development and sharing it with specific individuals or the public.
What will you learn?
The course covers various aspects of code sharing, including why you should consider sharing your code, when to share it, with whom to share it, how to do it effectively, licensing and intellectual property considerations, documenting your code, creating contributing guidelines, ensuring discoverability, and code maintenance.
Who this course is for?
This is for researchers, at any stage of their career, interested in or considering sharing their code with some or all stakeholders.
- Why you should consider sharing your code
- When to make your code publicly available
- With whom to share your code, including expected contributors and stakeholders
- How to share your code effectively, considering tools, licensing, and documentation
- Understanding code licenses and intellectual property
- Strategies for code discoverability, including persistent URLs and DOIs
- Code maintenance considerations, including updates, bug fixes, and user support
- Key takeaways and considerations for your code-sharing project
You’ll be learning from:
Dr. Marcos Del Pozo Banos is a senior lecturer at Swansea University Medical School. With over 10 years of experience, Marcos applies machine learning to a wide range of biometric problems in the fields of security, biology, and medicine. His research focuses on the analysis of routinely collected electronic health records for the study of suicide and self-harm prevention, applying advanced machine learning techniques alongside traditional epidemiological methods.
Course Duration
16 minutes.
When Can You Start?
Feel free to begin whenever it suits you. We’ve designed it to fit into your schedule.
Begin Your Learning
Simply press play on the video below to start your learning. You’ll have the flexibility to pause, rewind, and navigate through the content as desired.
Further reading: Congratulations on completing the Code Sharing and Co-Developing course! Please refer to the list below for additional resources and links. This list features recommended reading materials and online sources to further enrich your knowledge in this field. Enjoy your learning journey! Happy learning!
- Pros and Cons: https://www.freecodecamp.org/news/what-is-great-about-developing-open-source-and-what-is-not/
- GitHub (good first choice)
- GitLab
- Bitbucket
- SourceForge
- Licencing a GitHub repository: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository
- Copyleft: Viral licences that may introduce legal incompatibilities with other code.
- Permissive: Lax licences with minimal rules. MIT is a popular choice.
- Creative commons. Modular licence that allows you to select only what you need.
- Be attributed for your work! Get a DOI, publish code in specialised journals, remind users to cite you.
- Guide to writing documentation: https://www.writethedocs.org/guide/writing/beginners-guide-to-docs/
- Guide to writing contributing guidelines: https://opensource.com/life/16/3/contributor-guidelines-template-and-tips
- Other guidelines: https://docs.github.com/en/site-policy/github-terms/github-community-guidelines
- Get a DOI for your code
- Write code to automatically test the functioning of your code.
- Guide to maintaining code: https://simpleprogrammer.com/maintaining-code/
- NIH Best Practices for Sharing Research Software
- The ReadME Project
- Open Source Initiative: https://opensource.org/
Contact Us
Thank you for participating in this course. We value your opinion and would like to hear about your experience. Your feedback is essential in helping us enhance the course and create a better learning experience for future participants.
To reach us directly, please contact us at DATAMIND@swansea.ac.uk. We appreciate your input and look forward to making improvements based on your valuable insights. Thank you once again for being part of our learning community.
