diff --git a/README.md b/README.md index f2c33ec3..8aae83cf 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,126 @@ -# XpertAI Plugin Repository +# XpertAI Plugin Repository 🚀 -This is the source code repository for plugins on the [XpertAI platform](https://github.com/xpert-ai/xpert). The `xpertai/` folder contains officially maintained plugin projects. Partners or community contributors can create independent project folders in the root directory according to their company or organization, and maintain their own plugin code within. For plugin development and release processes, please refer to the official documentation: . +Welcome to the official source code repository for plugins on the [XpertAI platform](https://github.com/xpert-ai/xpert). -## Repository Structure +This repository serves as the central hub for developing, sharing, and maintaining XpertAI plugins. The `xpertai/` directory contains officially maintained plugin projects, while partners and community contributors can create their own independent project folders at the root level. -- `xpertai/`: Official plugin projects, managed with the Nx build tool for multiple plugin packages. -- `/`: Partner or community contributor plugin directories (example). Please create a top-level directory using your company or organization’s English name, and maintain plugin projects within. +For detailed plugin development and release guidelines, please visit our [official documentation](https://xpertai.cn/docs/plugin/). -## Getting Started +## 📁 Repository Structure -1. Clone the repository and enter the root directory. -2. To view or participate in official plugin development: - - Enter `xpertai/` and run `npm install` to install dependencies. - - Use `npx nx graph` or `npx nx list` to explore current plugins and tasks. - - Common commands: - - `npx nx build ` to build a plugin. - - `npx nx test ` to run unit tests. - - `npx nx lint ` to perform code linting. -3. To create a new partner plugin: - - Add a new `/` (your company/organization’s English name) directory in the repository root. - - Refer to the [official documentation](https://xpertai.cn/docs/plugin/) or the sample projects in `xpertai/` to initialize your project structure. - - You can also use the plugin project template repository to get started quickly: . - - It is recommended to provide a README or documentation explaining the plugin’s purpose, dependencies, and usage. +``` +xpert-plugins/ +├── xpertai/ # Official plugin projects (managed with Nx) +├── / # Partner/community plugin directories +└── ... +``` -## Development and Contribution Process +- **`xpertai/`** - Officially maintained plugin projects, using Nx build tool for efficient monorepo management +- **`/`** - Partner or community plugin directories. Create a top-level folder using your organization's English name -- Please follow the coding, testing, and release standards in your project directory, and ensure local builds and tests pass before submitting. -- Before submitting a Pull Request, please ensure: - - Your code passes necessary Lint, Test, and Build checks. - - Relevant documentation is updated (such as plugin README, CHANGELOG, etc.). - - You comply with your organization’s internal naming and branching conventions, as well as those of this repository. -- For changes to public files or official plugins, please communicate with the maintenance team first to ensure alignment. +## 🚀 Getting Started -## Plugin Release and Registration +### For Official Plugin Development -1. Complete the plugin packaging and release process according to the official guide: . -2. After releasing your plugin, you can register its metadata in the registry repository: . -3. When registering, please provide complete metadata (plugin name, version, description, dependencies, maintainer contact, etc.) and keep the information up to date. +1. **Clone the repository** + ```bash + git clone https://github.com/xpert-ai/xpert-plugins.git + cd xpert-plugins/xpertai + ``` -## Support and Feedback +2. **Install dependencies** + ```bash + npm install + ``` -- For issues with the official platform: contact XpertAI support channels or your enterprise customer success contact. -- For repository maintenance issues: create an issue in the GitHub Issues section, describing the situation and steps to reproduce. +3. **Explore available plugins** + ```bash + npx nx graph # Visualize project dependency graph + npx nx list # List all projects and available commands + ``` -Thank you for contributing to the XpertAI plugin ecosystem! +4. **Common commands** + ```bash + npx nx build # Build a specific plugin + npx nx test # Run unit tests + npx nx lint # Perform code linting + ``` + +### For Creating Partner Plugins + +1. **Create your organization directory** + - Add a new directory named after your company/organization in the repository root + - Example: `my-company/` + +2. **Initialize your project** + - Follow the [official documentation](https://xpertai.cn/docs/plugin/) for setup instructions + - Reference existing projects in `xpertai/` for best practices + - Use the [plugin starter template](https://github.com/xpert-ai/xpert-plugins-starter) for quick setup + +3. **Document your plugin** + - Include a README explaining the plugin's purpose, features, and usage + - List dependencies and installation requirements + - Provide examples and troubleshooting tips + +## 🤝 Development & Contribution + +### Before Contributing + +- ✅ Follow coding standards in your project directory +- ✅ Ensure all local builds and tests pass +- ✅ Keep documentation up-to-date +- ✅ Comply with your organization's naming and branching conventions + +### Pull Request Checklist + +Before submitting a PR, please ensure: + +- [ ] Code passes Lint, Test, and Build checks +- [ ] Documentation is updated (README, CHANGELOG, etc.) +- [ ] Commits follow conventional commit format +- [ ] PR description clearly explains changes +- [ ] For official plugins: discussed with the maintenance team first + +### Code Review Process + +- All PRs require review and approval +- CI/CD checks must pass before merge +- Major changes to official plugins require maintainer approval + +## 📦 Plugin Release & Registration + +1. **Build & Publish** + - Follow the [official release guide](https://xpertai.cn/docs/plugin/) + - Ensure version numbers follow semantic versioning + +2. **Register Your Plugin** + - Add metadata to the [plugin registry](https://github.com/xpert-ai/xpert-plugin-registry) + - Provide complete information: + - Plugin name and version + - Description and features + - Dependencies + - Maintainer contact + - License + +3. **Keep it Updated** + - Maintain accurate metadata as your plugin evolves + - Update registry entries with new releases + +## 💬 Support & Feedback + +- **Platform Issues**: Contact XpertAI support or your enterprise customer success team +- **Repository Issues**: Create a [GitHub Issue](https://github.com/xpert-ai/xpert-plugins/issues) with detailed reproduction steps +- **Feature Requests**: Open an issue with the `enhancement` label +- **Questions**: Use GitHub Discussions for community Q&A + +## 📄 License + +Please refer to the LICENSE file for details. + +## 🙏 Acknowledgments + +Thank you for contributing to the XpertAI plugin ecosystem! Your help makes the platform more powerful and accessible for everyone. + +--- + +**Need Help?** Check out our [documentation](https://xpertai.cn/docs/plugin/) or join our community discussions.