Skip to content

Latest commit

 

History

History
17 lines (11 loc) · 1.84 KB

File metadata and controls

17 lines (11 loc) · 1.84 KB

Contributing MiniApps

English | 简体中文

We welcome tools, games, and other interesting apps you have built for MiniMax Code.

  1. Fork this repository and add your complete plugin package under plugins/<your-github-username>/<plugin-id>/. Use a lowercase GitHub username for the author directory.
  2. Include the hidden .minimax-plugin/ directory, package.json, miniapp/, and all required runtime assets. The plugin must work when copied on its own, without depending on other directories in this repository.
  3. Add a short English README.md. You may also include README.zh-CN.md with links between the two versions. Explain what the app does, how to install and use it, tested client versions and operating systems, required configuration, file access, and network requests. Screenshots or GIFs are welcome.
  4. Include a LICENSE you are entitled to use, and preserve required attribution for third-party code and assets.
  5. Add an entry to the app tables in both root READMEs and open a pull request.

The plugin directory name must match name in .minimax-plugin/plugin.json. Plugin IDs must be unique across the repository, since the author directory is not kept during installation. If a name is already taken, consider adding an author prefix.

Submit ready-to-run files. If the app requires a build step, include its source and build instructions. Do not commit node_modules/, credentials, real session records, personal data, or runtime caches. Use synthetic or thoroughly anonymized data in screenshots and examples.

Before submitting, install the app in MiniMax Code, open it, and check its main features. Include your test environment and results in the pull request, and state any unverified behavior. When updating an existing app, keep its plugin ID and update the version and usage instructions as appropriate.