4OSS-lesson

Overview

Lesson development hackathon for teaching best practices in research software development is based on four simple recommendations 1 (4OSS). We are adopting the Carpentries philosophy and policy for developing and maintaning training material to help us in providing clear guidelines on how to implement the 4OSS recommendations.

1. Make source code publicly accessible from day one
2. Adopt a licence and comply with the licence of third-party dependencies
3. Define clear and transparent contribution, governance and communication processes
4. Make software easy to discover by providing software metadata via a popular community registry

[1] https://f1000research.com/articles/6-876/v1

Aim

The overall aim of these 4OSS in the shape of training materials will contribute to make research software FAIR.

Contributing

Thanks for coming by, this is an open source project and we welcome your contributions. This lesson material is being developed in the open, and would benefit from your contributions. There are a number of ways you can help make this materials even better:

• If something is unclear please send an issue so we can address anything that is confusing.
• If you are using this lesson to teach it or as part of your workshop please share it!
• If you spot a typo, feel free to edit the underlying page and send a pull request. If you've never done this before, follow the hello world example from github pages.
• If you make a significant contribution you will be listed as an author, please contact us to discuss this.

Communication

You can raise your comments, improvements and questions using issues. We also highly encourage the use of labels for each new issue. We are working remotely and meeting in person from time to time. We communicate by email and through github issues.

You can have a look at the useful resources if you need more information about the project.

Timeline 2018

• June
  • Brainstorming workhsop CarpentryCon, Dublin (1 June) and notes
  • Poster and short talk ELIXIR all hands, Berlin (6 June)
• August
  • Lesson development hackathon, Utrecht (1-3 August) and Progress
• September
  • ECCB2018, Athens (8-12 September)
  • Aprove content (21 September)
  • Issue Bonanza (24-25 September)
• October
  • Workshop, Utrecht (2 October)
  • Bug BBQ (3-4 October)
  • hackathon at NETTAB2018, Genoa (24-25 October)
  • short talk WSSSPE, Amsterdam (29 October), Presentation
• November
  • BioHackathon, Paris (12-16 November)
  • BioHackathon background information and expected outcomes

Check out our deadlines! and help us in the process

License

All Software Carpentry and Data Carpentry instructional material is made available under the Creative Commons Attribution license CC by 4.0. Please see LICENSE for more details.

Citation

"4 Open Source Software Recommendations" lesson materials Version 2018.01, August 2018, Mateusz Kuzak, Allegra Via, Fotis E. Psomopoulos, Paula Andrea Martinez, Jen Harrow and Rafael C. Jimenez (eds): https://github.com/SoftDev4Research/4OSS-lesson In progress. Creative Commons Attribution license CC by 4.0.