Published

Contributing to CMEED

Sparsh Varshney
Sparsh Varshney
0

Open-source chess research dataset containing 994,269 engine-annotated inaccuracies, mistakes, and blunders from 140,662 broadcast games (Jan–May 2026). www.chessmultiverse.org

Contributing to CMEED

Thank you for your interest in contributing to the Chess Multiverse Error & Evaluation Dataset (CMEED).

CMEED is an open research initiative dedicated to advancing chess analytics, human error modeling, and reproducible chess research. Contributions from researchers, developers, data scientists, students, and chess enthusiasts are welcome.

Ways to Contribute

You can contribute in several ways:

🐛 Report Issues

If you discover:

  • Incorrect data
  • Parsing bugs
  • Broken game records
  • Invalid FEN positions
  • Metadata inconsistencies
  • Documentation errors

please open a GitHub Issue with as much detail as possible.

📊 Improve Dataset Quality

Contributions that improve data quality are especially valuable.

Examples include:

  • Validation scripts
  • Error detection improvements
  • Duplicate record detection
  • Missing metadata recovery
  • Statistical audits
  • Schema enhancements

💻 Software & Tooling

Developers may contribute:

  • Data extraction tools
  • PGN parsers
  • Validation pipelines
  • Research notebooks
  • Visualization tools
  • API integrations
  • Web explorer improvements

📚 Documentation

Documentation improvements are always welcome.

Examples:

  • README enhancements
  • Tutorials
  • Usage examples
  • Research guides
  • Schema explanations
  • Citation examples

Development Workflow

1. Fork the Repository

Create your own fork of the repository.

git clone https://github.com/YOUR_USERNAME/Chess-Multiverse-Error-Evaluation-Dataset-CMEED-.git

2. Create a Branch

Create a dedicated branch for your changes.

git checkout -b feature/your-feature-name

Example:

git checkout -b feature/fen-validator

3. Make Your Changes

Implement improvements while maintaining:

  • Data integrity
  • Reproducibility
  • Documentation quality
  • Backward compatibility where possible

4. Commit Changes

Use clear commit messages.

Examples:

git commit -m "Add FEN validation script"

git commit -m "Fix player title parsing bug"

git commit -m "Improve README documentation"

5. Push Your Branch

git push origin feature/your-feature-name

6. Open a Pull Request

Provide:

  • Summary of changes
  • Motivation
  • Expected impact
  • Testing performed

Maintainers will review the contribution before merging.

Data Contribution Guidelines

When contributing data:

Requirements

  • Data must be reproducible.
  • Source datasets must be documented.
  • Processing methods must be transparent.
  • Records must follow the official CMEED schema.
  • Data must comply with applicable licenses and terms of use.

Validation Expectations

Contributors should verify:

  • Valid JSON formatting
  • Correct field names
  • Valid FEN strings
  • Accurate metadata
  • No intentionally manipulated records

Research Contributions

Researchers are encouraged to contribute:

  • Statistical analyses
  • Benchmark studies
  • Error prediction models
  • Academic publications
  • Validation reports
  • Derived datasets

If you publish work using CMEED, please consider citing the dataset.

Coding Standards

Preferred technologies include:

  • Python
  • JavaScript
  • TypeScript
  • SQL
  • Data Science Libraries

General expectations:

  • Write readable code.
  • Include comments where appropriate.
  • Follow consistent naming conventions.
  • Avoid unnecessary dependencies.
  • Document significant changes.

Pull Request Checklist

Before submitting a Pull Request:

  • Changes have been tested.
  • Documentation has been updated.
  • Dataset integrity is preserved.
  • JSON outputs remain valid.
  • No unnecessary files are included.
  • Commit messages are descriptive.

Community Standards

All contributors are expected to follow the project's Code of Conduct.

Please read:

CODE_OF_CONDUCT.md

before participating.

Citation

If your contribution results in a publication, please cite the current CMEED release and DOI.

Contact

Project Maintainer:

Sparsh Varshney

Founder, Chess Multiverse

GitHub: https://github.com/sciencewithsaucee-sudo

ORCID: https://orcid.org/0009-0004-7835-0673

Thank You

Every contribution—whether a bug report, documentation improvement, validation script, or research paper—helps improve the quality and impact of open chess research.

♟️ Together we can build a richer understanding of human chess decision-making through open data.