isv-corpus / CONTRIBUTING.md
interslavic-oss's picture
Initial upload: Interslavic MT corpus with monolingual data and documentation
8a49bd9 verified

Contributing to Interslavic MT Data

Thank you for contributing. This repo is data-only: we accept contributions to the monolingual and parallel corpora, following the formats below.


Repo layout

  • monolingual/isv_sentences.parquet — Single source of truth for Interslavic sentences. Do not add rows that have not been verified.
  • parallel/ — One Parquet file per language pair, e.g. isv-eng.parquet, isv-rus.parquet.

Monolingual schema

Column Type Description
id string Unique id (e.g. isv-0001). Must be unique across the file.
sentence string The Interslavic sentence.
source string Source identifier; each value maps to a documented license (see SOURCES.md or CONTRIBUTING).
  • No duplicate ids.
  • No nulls in id, sentence, or source.

Parallel schema

Column Type Description
id string Must exist in monolingual/isv_sentences.parquet.
isv string Must match the sentence for that id in the monolingual file exactly.
target string Translation in the target language.
translator string Who provided the translation (person or system).
method string One of: human, machine_raw, machine_postedited.
review_status string e.g. unreviewed, approved, rejected.
  • Every id must exist in the monolingual dataset.
  • isv must match the monolingual sentence for that id exactly (no whitespace or normalization differences).

Workflow

  1. Add or edit rows in parallel/isv-{lang}.parquet (or add a new pair file with the same schema).
  2. Ensure each row references an existing id from the monolingual set and that isv matches.
  3. Set method and review_status appropriately (e.g. unreviewed for new submissions).
  4. Run python scripts/validate_corpus.py before committing; fix any format errors.
  5. ISLF maintainers will review when needed.

Adding new sentences to the monolingual set is done in coordination with maintainers so that sources and licenses are documented.


License per source

Each source value in the monolingual file corresponds to one documented license. Contributors must have rights to contribute under that license; by submitting, you confirm that. We do not mix incompatible licenses into one work — see LICENSE.md.