search

codecheckers / discussion

General discussions and questions
0 stars 0 forks source link

CODECHECK configuration file - codecheck.yml #3

Open nuest opened 4 years ago

nuest commented 4 years ago

Some ideas for future elements

command: "..." # for rare cases where user needs to define this, but normally should be auto-generated from format

checks: # there may be multiple checks?
  - ...

codechecker:
  check_runner: "mybinder.org" # who executed the check
  check_signature: "..." # something crpytographic?!
nuest commented 4 years ago

Each author MAY also have a role node with a suitable value from the MARC Code List for Relators, such as aut for Author, ctb for contributor, dtc for data contributor, fnd for funder, ths for thesis advisor, or cph for copyright holder.

authors:
  - name: Josiah Carberry
    ORCID: 0000-0002-1825-0097
    role: aut
  - name: John Doe
    role: ctb
  - name: ACME Inc. Corp.
    role: cph
mstimberg commented 3 years ago

Another relevant field might be the licence of the original code (and possibly a separate licence for the codecheck?). Not sure how much flexibility would be needed, e.g. one licence for the code and one for the data? Or even licences for individual files (optionally, of course) – might be necessary if they have been included from elsewhere. And a licence could be either described by its SPDX identifer or by a file in the repository (e.g. with license or license_file keys as in conda metadata).