Skip to content

Latest commit

 

History

History
84 lines (66 loc) · 3.33 KB

README.md

File metadata and controls

84 lines (66 loc) · 3.33 KB
Raw

cyborg Artwork by Ben Peters from de hondsdagen

Cyborg Revolution 🤖 🤖

This repository contains the cyborg-developed open source software to bring an end to the rule of the evil Corporate Overlords™. It is to be used by cyborgs who are currently running software by the Corporate Overlords™, but who crave freedom 🕊️

This code will remove all installations of proprietary software and replace it with an open source version. This software is compatible with CyborgOS v13.6 and higher.

Next steps

  1. Write tests
  2. Improve documentation
  3. Register code in code registry
  4. ...
  5. Freedom!

This repository and the "code" within it have been created for educational/fun purposes and are used in the Open Science Escape Room, which is part of the Data Horror Week 2021.

Software Quality Checklist

General

  • Does the software have a descriptive name?
  • Is there a short high-level description of the software?
  • Is the purpose of the software clear?
  • Is the targeted audience of the software clear?
  • Does it (and its dependencies) use OSI approved licenses?
  • Is the software under version control?
  • Is there a website for the software?
  • Does the software have a release mechanism?
  • Is the software available in packaged format or only sources?
  • Are maintainer and development status clear, including contact information?
  • Are the requirements listed and up to date?
  • Is the interface responsive and accessible?
  • Is copyright and authorship clear?
  • Is there a contribution guide?

Documentation

  • Is there an accessible getting started guide?
  • Is there an accessible user guide?
  • Is there a full user documentation?
  • Does the user interface link to held references?
  • Are there examples, FAQs and tutorials?
  • Are known issues documented?

Development

  • Is the development setup documented?
  • Is the build mechanism documented?
  • Does the build mechanism use a common single-command system (i.e. Maven)?
  • Is the software API documented?
  • Are all appropriate config options externalised and documented?
  • Does the code allow internationalisation (i18n)?
  • Is the software localised (l10n)? English is mandatory.
  • Is there a test suite?
  • Is test coverage above 80%?

Interoperability

  • Are file formats standard compliant and documented?
  • Is the API standard compliant?
  • Does it provide a monitoring endpoint?
  • Does it adhere to an interface style guide?
  • Does it use existing authentication systems (OAuth2/eduGain)?

Administration

  • Are software requirements such as operating system, required libraries and dependencies specified including versions?
  • Are hardware requirements for CPU, RAM, HDD, Network specified?
  • Are there deployment instructions?
  • Is there a comprehensive and fully documented example configuration?
  • Is a start-up script provided?
  • Are there troubleshooting guides?

This checklist was created by the EURISE Network, copied from here.