Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
111 lines (66 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

111 lines (66 loc) · 3.19 KB
Raw

Contributing Guidelines

⚠️ Copyright and Permissions

The Digital Splitleaf cannot publish, host, or distribute any material that is still under copyright without written permission from the publisher or rights‑holder.

This includes:

  • Modern psalter translations or revisions
  • Newly composed metrical settings
  • Edited, typeset, or annotated versions of public‑domain texts

If you are unsure whether your edition is in the public domain, please contact the DS team before submitting any files.

🗂️ Workflow Overview

1. Check for an Existing Edition

Before submitting a new psalter edition, please verify whether it is already available on the Digital Splitleaf.
Duplicate submissions slow down processing and create unnecessary editorial workload.

2. Submit a New Edition

If your edition is not yet included, place your files in the 'newEditions' folder.

Supported formats for Psalm texts:

  • .txt (preferred)
  • .docx
  • .pdf

Supported formats for music:

  • .musicXML (preferred)
  • .mscz (MuseScore)
  • .xml (Music Encoding Initiative)

Once the edition has been processed, the uploaded source files will be deleted.

3. Initial Processing by the Splitleaf Team

All submitted editions will be reviewed by the Splitleaf editors.
The team will:

  • Evaluate the submitted text
  • Create the initial XML file
  • Publish that XML file in the 'processing' folder.

4. Mandatory Editorial Verification

In the processing folder, files can be edited by any user. Before any file can be published on the Digital Splitleaf:

  • It must be verified by two independent editors
  • Their names must appear at the top of the XML file

No submission will advance to publication without these dual approvals.

This project uses GitHub pull requests as its formal editorial and validation mechanism.

  • Editors and validators are recorded automatically after a pull request is merged..

Anonymity

If you wish to be credited anonymously:

  • Editors: include the word "anonymous" in the pull request description.
  • Validators: include the word "anonymous" in your approval comment.

GitHub identities are retained internally for audit purposes, but may not appear in published files.

5. Review of Submitted Changes

The DS editorial team will evaluate every submission for:

  • Accuracy
  • Faithfulness to the source
  • XML structural integrity
  • Consistency with DS editorial guidelines

Changes may be accepted, revised, or returned with comments.

6. Final Publication

Once:

  • All changes have been accepted, and
  • The text has been independently reviewed by two editors

…the file will be published in the appropriate location within the 'texts' folder. This folder contains the final, stable XML versions of psalter editions on the Digital Splitleaf. These files can also be edited using step 5 above.

🙏 Thank You for Contributing

Your work helps preserve, share, and strengthen the rich heritage of psalm‑singing across traditions and generations. If you have questions about the process, encoding guidelines, copyright concerns, or XML structure, please contact the Digital Splitleaf team.