Skip to content

Document safe synthetic test data for contributors #44

Description

@aoiminamoto

Problem

KinaBot's contribution rules correctly prohibit publishing participant audio, transcripts, personal data, credentials, or production exports. A new contributor still needs concrete examples of how to create safe synthetic inputs for bug reports, tests, screenshots, and documentation.

Desired outcome

Add docs/SYNTHETIC-TEST-DATA.md, a short practical guide showing contributors how to create clearly fictional, non-clinical test material without copying or lightly editing real participant data.

Acceptance criteria

  • Explain the difference between synthetic, anonymized, pseudonymized, and redacted data in plain language.
  • State that anonymization or removing names may still leave voice and language data identifiable.
  • Include one short, clearly fictional text example for each currently supported language: English, Japanese, and Chinese.
  • Include safe examples for a bug report, automated unit test, screenshot, and sanitized log.
  • Include a “never include” checklist covering audio, transcripts, email addresses, participant IDs, credentials, medical details, local databases, and production exports.
  • Explain what to do if a bug can only be reproduced with sensitive data: stop, do not upload it, and use the private path described in SECURITY.md.
  • Link the new guide from CONTRIBUTING.md.
  • Use no real participant or production data in the contribution.
  • Pass git diff --check and the repository's existing CI.

Scope guidance

This is a repository-root documentation-only task. It must not modify aoi_kinabot_app/, which is protected by the Aoi-maintained authorship boundary. It does not require changing the application, collecting data, generating realistic voice recordings, or making legal/compliance claims. Keep the guide concise and usable by a first-time contributor.

Helpful starting points

  • CONTRIBUTING.md
  • SECURITY.md
  • existing synthetic examples in the Python tests

Before starting, leave a short comment so another contributor does not duplicate the work. A maintainer can clarify scope in the issue.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is neededprivacyPrivacy, consent, retention, deletion, or data-minimization work

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions