Contribute

Contribute a Model

Thank you for your interest in contributing to HCIspecs.

HCIspecs is a curated repository of interaction models used in research and teaching.
We welcome contributions that align with the repository’s scope and quality standards.

All submissions are reviewed before publication.

How to Submit

Models are submitted via Pull Request (GitHub).

Fork the repository (or create a branch if you have access).
Add your model metadata file under _models/.
Add associated files under assets/models/.
Open a Pull Request describing your submission.
The maintainers will review and respond.

Detailed technical instructions are available in the repository’s README.md.

What to Include

Each submission must include:

A metadata file with complete YAML frontmatter
At least one version entry
Model files stored under assets/models/<record_id>/
Links to related publications (if applicable)

Temporary identifiers (e.g., M-TEMP-<shortname>) may be used.
Final record IDs are assigned during review.

Review Criteria

Submissions are evaluated for:

Structural correctness
Metadata completeness
Consistency with repository conventions
Clarity of description
Licensing suitability

Revisions may be requested before acceptance.

Licensing

Contributors must ensure they have the right to distribute submitted materials.
If the model includes third-party content, appropriate permissions must be documented.

Need Assistance?

If you are unfamiliar with Git or the submission process, please contact the maintainers for assistance.

Thank you for helping maintain a high-quality repository of interaction models.