Skip to content

How to contribute to the SIS

Piotr Banski edited this page Jul 11, 2023 · 4 revisions

The best way to see more precise and better visualized information in the SIS is to contribute to it directly via GitHub.

The SIS repository is located at https://github.com/clarin-eric/standards

The best target for code-related contributions is the "dev" branch at https://github.com/clarin-eric/standards/tree/dev/SIS/clarin

The best target for content-related contributions is the "formats" branch under https://github.com/clarin-eric/standards/tree/formats/SIS/clarin/data . Places of interest on that page include the formats and recommendations directories.

  • formats contains individual format descriptions, sometimes very rudimentary and begging to be extended; the content of this directory is listed in the Data Deposition Formats menu item of the SIS
  • recommendations contains individual recommendation lists, organised per centre; contributing there is the topic of the wiki page Updating format recommendations

In order to see what formats are used in recommendations but missing from the formats directory, please check the Sanity Checker page -- the missing formats are listed at the top, and one can either click on the reserved format ID in that list to start editing a GitHub issue to tell us what should go into the description, or one can add a new file under formats, with that ID used as an attribute at the top -- so, if fMissingFormat is listed there, one can create a file data/formats/fMissingFormat.xml, beginning with:

<format xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="fMissingFormat" xsi:noNamespaceSchemaLocation="../../schemas/format.xsd" display="show">

(note the id="fMissingFormat" in the line above).

If you don't feel like submitting a pull request with your suggested modifications, please consider using the issues to signal bugs or suggest extensions.

Clone this wiki locally