Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 2.84 KB

File metadata and controls

69 lines (47 loc) · 2.84 KB

Contributing to MetaCore Studio

English | 简体中文

English

Thank you for helping improve MetaCore Studio. Contributions should stay focused on embedded engineering workflows, hardware safety, maintainable frontend architecture, and controlled localhost operations.

Development setup

npm ci
npm run dev
npm run dev:server

The frontend and localhost service run as separate processes. On Windows, start.bat starts the complete mode and is useful for a quick manual check; start-local.bat is a compatibility alias. Do not commit API keys, local workspace data, generated backups, or provider credentials.

Change workflow

  1. Create a focused branch from main.
  2. Keep changes within the existing module boundaries under components, services, store, types, and server.
  3. Add reusable components when the same behavior or visual element appears in more than one place.
  4. Add or update smoke tests for localhost service behavior.
  5. Run the required checks before opening a pull request.

New AI suppliers must implement the provider adapter contract instead of adding supplier-specific branches to route handlers. Do not add public provider credentials, shared API keys, billing configuration, or private partner endpoints to the repository.

npm run check

Pull requests

  • Explain the user-visible behavior and technical approach.
  • Keep unrelated refactors out of the same pull request.
  • Include screenshots for UI changes.
  • Document new configuration, API routes, security boundaries, or migration steps.
  • Confirm that no secrets or personal local data are included.

简体中文

感谢参与改进 MetaCore Studio。贡献内容应围绕嵌入式工程流程、硬件安全、可维护的前端架构以及受控的 localhost 本地操作展开。

开发环境

npm ci
npm run dev
npm run dev:server

前端和本地服务需要分别启动。Windows 可以双击 start.bat 启动完整模式,start-local.bat 为兼容旧入口。请勿提交 API Key、本地工作区内容、自动备份文件或服务商凭据。

修改流程

  1. main 创建职责明确的功能分支。
  2. 保持 componentsservicesstoretypesserver 等现有模块边界。
  3. 同一行为或视觉元素出现多次时,优先提取可复用组件。
  4. 修改本地服务行为时,添加或更新冒烟测试。
  5. 创建 Pull Request 前运行必要检查。

新增 AI 供应商时,应实现服务商适配器契约,不要在路由处理中不断增加供应商专用分支。不得向仓库加入公共供应商凭据、共享 API Key、计费配置或私人合作接口。

npm run check

Pull Request 应说明用户可见变化和技术实现;UI 修改应附截图;新增配置、API、安全边界或迁移步骤应同步更新文档。