starescomp / guidance Goto Github PK

How to demonstrate the impact of software created in the course of research e.g. http://depsy.org

• Brief overview of Virtualisation and Container technologies
• Relevance to reproducible research

Should include

• Why version control is important in the research context
• Very brief primer on version control systems with links to more detailed material
• Description and guidance on the use of preferred solutions (currently GitHub and institutional Git Repository)
• Links to further resources, details on available training

How to cite software and make your software citable.

• Why code should be shared
• When code should not be shared

Securing web applications

• SQL injection
• Cross-site scripting
• SSL
• Encrypting passwords
• File permissions
• Handling file uploads
• ...

• Why testing is important
• Different kinds of test
• Automated testing
• Code coverage

• What documentation should be made available with software
• Automated generation of documentation
• Writing good comments

Overview/introduction on the the importance of sustainable software development to reproducible research.

Should include:

• Details of any relevant training offered at the University
  • Software Carpentry
  • Statistics with R
  • TEI
  • Any Research Data Management training
• External training resources, including Software/Data/Library Carpentry

Guidance on choosing a license - see http://choosealicense.com

May need to develop an institutional position on preferred default - some institutions prefer Apache over MIT because of patent issues.

• The difference between an archive like Zenodo and a platform like GitHub
• Description of the preferred method (GitHub to Zenodo)