Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 1.77 KB

Contributing

RealMythos is currently preparing its first public release. During this stage, contributions should focus on documentation clarity, release review, responsible-use language, and reproducibility planning.

Current Contribution Scope

At this stage, please avoid submitting large data files, model checkpoints, or generated traces directly to Git.

Useful contributions include:

  • Documentation improvements
  • Dataset card review
  • Technical report review
  • Schema and metadata suggestions
  • Release checklist improvements
  • Responsible-use and safety review
  • Reproducibility planning
  • Roadmap issue proposals

Issue Types

Use issues to discuss:

  • Dataset documentation gaps
  • Ambiguous terminology
  • Missing release metadata
  • Safety concerns
  • Reproducibility requirements
  • Roadmap item proposals

Security-sensitive reports should not be posted as public issues. See SECURITY.md.

Pull Request Expectations

Pull requests should:

  • Be small and reviewable
  • Explain the motivation for the change
  • Avoid adding generated data artifacts
  • Avoid committing credentials, tokens, logs, or private paths
  • Keep public-facing claims conservative and verifiable

Documentation Style

Prefer precise claims over broad claims. Avoid saying that a release is "complete", "safe", or "fully reproducible" unless the statement is backed by public artifacts.

Use terms such as:

  • planned
  • current focus
  • internally evaluated
  • public evaluation pending
  • known limitation
  • subject to safety review

License Notes

The planned license policy is documented in LICENSES.md. Source code snippets derived from upstream projects may remain subject to their original upstream licenses.

Author and maintainer information is tracked in AUTHORS.md.