Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (22 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

36 lines (22 loc) · 2.38 KB
Raw

Contributing to TypeSafeAI Community

Unofficial community project — not the official TypeSafe AI team. Created by VC Moderator @BunsDev.

Small documentation fixes, reproducible examples, accessibility improvements, and focused project contributions are welcome. This file is the default for repositories that don't have their own; a repository's CONTRIBUTING.md takes precedence.

How to contribute

  1. Pick the right repository. The community profile lists every project and what it is for. Read its README, AGENTS.md, and CONTRIBUTING.md.
  2. Check existing issues and discussions before opening a new one. For larger changes, open an issue first so maintainers can confirm the direction.
  3. Branch and keep the change narrow. One concern per pull request.
  4. Verify. Run the repository's documented build, lint, and test commands. Start offline or in demo mode where supported; a live API key is optional for most contributions.
  5. Open a pull request that explains what changed, how you verified it, and whether results are mocked or live.

Evidence and honesty

  • Do not present mocked or simulated output as live provider evidence.
  • Link a measured claim to the exact run, commit, and inputs that produced it. One live run is not a general accuracy claim.
  • A typed Jev result is a judgment, not authorization. Keep policy and authorization checks in application code.
  • Do not invent benchmark results, package availability, deployment URLs, passing checks, or production readiness.

Agent-assisted contributions

Agent-assisted work is welcome. You remain the author: review every line, disclose substantial agent involvement in the PR, and don't submit bulk or automated issues or PRs without a maintainer's agreement.

Safety

Never publish API keys, credentials, or private data in code, issues, screenshots, or example inputs. Use synthetic data. Report vulnerabilities privately as described in SECURITY.md.

Attribution and licensing

Preserve original author credits and license notices. Check a repository's license before reusing its code elsewhere.

Community standards

Participation is covered by the Code of Conduct. For help, see SUPPORT.md. Official TypeSafe AI product, account, billing, and API questions belong with the official team.