Skip to content

Welcome to the Super-Repo Documentation#

A template repo to test and document elements and features for research software.
It implements the collection of repository elements and files.
The goal is to simplify and standardise the creation of software in GitHub repositories.

Documentation Structure#

The documentation is separated into two main sections: development and code documentation.

Fields for development#

Files and structures related to collaborative development, community processes, and documentation.

  • COLLABORATION
  • GIT
  • DOCUMENTATION
  • RELEASE

Fields for code documentation#

Methods and standards of the module.

  • INSTALL
  • CODE-STYLE
  • TESTS
  • LOGGING