Giter Club home page Giter Club logo

guidance's Introduction

Guidance for RSEs at St Andrews

Join the chat at https://gitter.im/sta-rse-guidance/Lobby

As of November 2016, the University of St Andrews does not make available any online guidance or other resources to support the development of software for research. The purpose of this repository is to draft such materials.

Markdown files covering various topics are to be created in the [/](root directory). Resources, references and tools which might inform the guidance, which might be cited or to which we might direct users can be collected in resources.md.

Feel free to contribute via pull requests or issues. Please note that while we greatly appreciate any and all contributions and believe that this process will help us to create a resource of the greatest possible usefulness to RSEs at St Andrews, all guidance will need to be in line with the relevant University policies and guidance in related areas (e.g. Research Data Management).

Page drafts can be browsed at https://starescomp.github.io/Guidance/.

Creative Commons License
This work is licensed under a Creative Commons Attribution 4.0 International License.

guidance's People

Contributors

gitter-badger avatar pgmccann avatar

Stargazers

avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar

Forkers

gitter-badger

guidance's Issues

Training

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

Security

Securing web applications

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

Documentation

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

Software Licensing

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.

Version Control

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

Testing

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

Sharing code

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

Software Archiving

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.