Skip to content

Add explicit license and dataset usage boundaries #7

Description

@botaruibo

Why this matters

MyVoiceTyping is positioned as an open-source, local-first Chinese voice typing project, and the promotion plan now relies heavily on three public assets:

However, the current GitHub API shows:

  • App repo: license: null
  • Dataset repo: license: null
  • ModelScope model page: License: apache-2.0

For users, developers, newsletters, awesome lists, and teams evaluating the project, this is a trust and adoption blocker. People need to know whether they can fork, modify, redistribute, train with, or commercially evaluate the project and related assets.

Goals

  • Add a clear project-level license to the app repository.
  • Clarify that the app code, model artifacts, and dataset may have different license / usage boundaries.
  • Add dataset source and usage notes so the training data can be evaluated responsibly.
  • Make the README and landing page safer to share in open-source communities.

Suggested tasks

App repository

  • Choose a project license: MIT, Apache-2.0, GPL-3.0, or AGPL-3.0.
  • Add LICENSE to the repository root.
  • Add a README license section / badge.
  • Add a short license note to the landing page.

For early community growth and easier adoption, MIT or Apache-2.0 may be the most practical choices. Final choice should be made by the maintainer.

Dataset repository

  • Add DATA_LICENSE.md or equivalent usage notes.
  • Add docs/SOURCES.md listing each upstream dataset source, original link, license, citation requirements, commercial-use status, redistribution status, and sample count.
  • Clarify that samples remain subject to upstream dataset licenses unless explicitly stated otherwise.
  • Add README wording that users must verify upstream licenses before redistribution, publication, commercial training, or model release.

Model page / docs

  • Keep the ModelScope Apache-2.0 signal visible.
  • Mention that the model is based on Qwen/Qwen2.5-1.5B-Instruct and users must also comply with upstream model terms.
  • Link to the dataset usage notes once added.

Suggested README wording

## License / Usage boundaries

The app code, model artifacts, and dataset may have different license or usage terms.

- App code: TODO, pending maintainer decision.
- Model: the ModelScope page currently marks the model as Apache-2.0; users should also comply with the upstream Qwen model terms.
- Dataset: built from multiple public upstream datasets. Before redistribution, publication, commercial training, or model release, please check each upstream dataset's license, citation requirements, and usage restrictions.

Related internal promotion notes

This issue tracks a P0 trust signal for the 0 -> 1000 stars growth plan. Clear licensing will help with:

  • developer confidence;
  • awesome-list / newsletter submissions;
  • company/team evaluation;
  • reuse and contribution decisions;
  • accurate community promotion language.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions