September 8, 2020
Fair Software workshop introduces the five recommendations, presented on the fair-software.eu, on how to make research software more FAIR.
The five recommendations are:
- Use a publicly accessible repository with version control.
- Add a license.
- Register your code in a community registry.
- Enable citation of the software.
- Use a software quality checklist.
Requirements: Participants must join online session from a computer with a Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.). To prepare for the workshop they should follow setup instructions described below.
Contact: Please email firstname.lastname@example.org for more information.
Find more information about this event on the workshop website
|09:15||Introduction to 5 FAIR software recommendations|
|09:30||Use a publicly accessible repository with version control|
|10:25||Add a license|
|10:55||Register your code in a community registry|
|11:40||Enable citation of the software|
|12:10||Use a software quality checklist|
|12:40||Wrap up, feedback|
We will use this collaborative document for chatting, taking notes, and sharing URLs and bits of code.
Use a publicly accessible repository with version control
- Create open online repository on GitHub
- Publish and version control your source code
Add a license
- How do I choose a license?
- Online resources to help you choose a license
- Add license to your repository
Register your code in a community registry
- What is a software registry?
- Why is it important to register your software?
- How do you choose a registry?
Enable citation of the software
- What is software citation?
- Why is software citation important?
- How to tell users how to cite your software?
- What is DOI, CITATION.cff and CodeMeta?
Use a software quality checklist
- What is a software quality checklist?
- Why should I use a cheklist?
- What are the checklists I can use?
To participate in an online FAIR Software Workshop, you will need to follow instructions described below. In addition, you will need an up-to-date web browser.
Zoom Video Conferencing Software
The workshop will be delivered via the Zoom conferencing platform. You will need to install and test Zoom on your computer. Please follow the instructions on these web pages:
We will be learning how to create a GitHub repository and how to deposit your software there. You will need a GitHub account to do that.
Create a GitHub account if you haven’t done that yet. Make sure you remember your password and can log in.