suneditor 3.0.0-beta.1 → 3.0.0-beta.2

package/CONTRIBUTING.md

@@ -1,47 +1,184 @@
-# Guidelines For Contributing
+# 🌞 Guidelines For Contributing
 
-## Introduction
+---
 
-The codebase is written in JavaScript(ES2020), with JSDoc used for type definitions.  
-Node.js v14 or higher is required to build and test.
+## 📘 Introduction
 
-### Notes
+The codebase is written in **JavaScript (ES2020)**, using **JSDoc** for type definitions.  
+Node.js **v14 or higher** is required to build and test.
 
-- Uses modern syntax including:
-  - Optional chaining (`?.`)
-  - Nullish coalescing (`??`)
-  - Private class fields (`#myField`)
-- Polyfills are **not included** – make sure your target environment supports these features.
+### 📝 Notes
 
+-   Uses modern syntax including:
+    -   Optional chaining (`?.`)
+    -   Nullish coalescing (`??`)
+    -   Private class fields (`#myField`)
+-   Polyfills are **not included** – make sure your target environment supports these features.
 
-## Before submitting an issue
+---
 
--   If you're not using the latest master to generate API clients or server stubs, please give it another try by pulling the latest master as the issue may have already been addressed. Ref: [Getting Started]()
--   Search the [open issue](https://github.com/jihong88/suneditor/issues) and [closed issue](https://github.com/jihong88/suneditor/issues?q=is%3Aissue+is%3Aclosed) to ensure no one else has reported something similar before.
--   File an [issue ticket](https://github.com/jihong88/suneditor/issues/new) by providing all the required information.
+## 🐛 Before Submitting an Issue
 
-## Before submitting a PR
+-   Make sure you're using the latest `master` branch. Your issue may already be fixed.
+-   Search the [open issues](https://github.com/jihong88/suneditor/issues) and [closed issues](https://github.com/jihong88/suneditor/issues?q=is%3Aissue+is%3Aclosed) to avoid duplicates.
+-   If your issue is new, [file a ticket](https://github.com/jihong88/suneditor/issues/new) with detailed info, including reproduction steps if possible.
 
--   Search the [open issue](https://github.com/swagger-api/swagger-codegen/issues) to ensure no one else has reported something similar and no one is actively working on similar proposed change.
--   If no one has suggested something similar, open an ["issue"](https://github.com/swagger-api/swagger-codegen/issues) with your suggestion to gather feedback from the community.
--   It's recommended to **create a new git branch** for the change so that the merge commit message looks nicer in the commit history.
+---
 
-## How to contribute
+## ✅ Before Submitting a PR
 
-### code architecture
+-   Check that no one is working on the same thing in [open issues](https://github.com/jihong88/suneditor/issues).
+-   For new features or major changes, please open an issue first to gather feedback.
+-   Use a **feature branch** (not `master`) for your pull request.
+-   Make sure your code passes tests and doesn’t break existing functionality.
 
-### source formatter
+---
 
-### about css
+## 🤝 How to Contribute
 
-### Framework guide
+We welcome code contributions, bug reports, documentation improvements, or plugin ideas!
 
-Code change should conform to the programming style guide of the respective languages:
+### 🧹 Code Formatting
 
--   Vue: https://suneditor.com/framework-guide/vue
--   React: https://suneditor.com/framework-guide/react
--   Angular: https://suneditor.com/framework-guide/angular
+-   Use the provided **ESLint** configuration.
+-   4-space indentation
+-   Single quotes (`'`) for strings
 
-For other languages, feel free to suggest.
+---
 
-You may find the current code base not 100% conform to the coding style and we welcome contributions to fix those.
+## 🧩 Plugin Development
+
+SunEditor allows custom plugins using a flexible API.
+
+📘 Start from the [Plugin API Reference](https://suneditor.com/api/plugins)  
+🔍 Or explore the `src/plugins/` folder to see real examples.
+
+---
+
+## 🔁 CI/CD
+
+📦 The `dist/` folder is **not included** in the git repository.  
+⚙️ It is automatically built and deployed via **GitHub Actions** after changes are pushed to the `release` branch.  
+🛑 **Do not build or commit `dist/` files manually** – this may cause merge conflicts.  
+✅ The CI/CD pipeline ensures clean and consistent builds for every release.
+
+---
+
+## ⚙️ Framework Guide
+
+If you're contributing to framework integrations:
+
+-   React: [suneditor-react](https://github.com/JiHong88/suneditor-react)
+-   Vue: [suneditor-vue](https://github.com/JiHong88/suneditor-vue)
+
+💡 Feel free to propose wrappers for other frameworks too!
+
+---
+
+## 🤖 AI Plugin Helper
+
+Need real-time help?
+
+Check out **[SunEditor Devs AI](https://chatgpt.com/g/g-JViNPCrkD-suneditor-devs)** –
+
+> 💡 Just paste your code or describe your plugin idea – and get instant support.
+
+---
+
+## 🗂️ Code Architecture
+
+A quick overview of the `src/` directory:
+
+### `/core/` – 🧠 Editor Core Logic
+
+-   `editor.js`: Defines the main Editor class, managing lifecycle, commands, and overall orchestration
+-   `section/`: Context management and document setup
+-   `class/`: Core classes like toolbars, selections, HTML parsing, etc.
+-   `base/`: Undo/redo history, event manager, and shared core logic
+
+### `/helper/` – 🛠️ Utility Functions
+
+-   String converters, clipboard helpers, DOM queries
+-   `helper/dom/`: Low-level DOM operations
+
+### `/modules/` – 🧩 Reusable UI Modules
+
+-   Functional components like:
+    -   `Modal`, `ColorPicker`, `SelectMenu`, `FileManager`, etc.
+-   Useful for building consistent plugin UIs
+
+### `/editorInjector/` – 🧬 Plugin Integration Point
+
+-   Wraps and initializes the core editor
+-   Plugins must inherit from this to register correctly
+
+### `/plugins/` – ✨ Feature Extensions
+
+-   Modular plugins organized by type:
+    -   Examples: `image`, `video`, `link`, `blockquote`, etc.
+-   Each plugin is isolated and optional
+
+### `/langs/` – 🌍 i18n Support
+
+-   Language packs in separate JS files
+
+### `/assets/` – 🎨 Styles & Icons
+
+-   CSS for editor layout and themes
+-   SVG icon sets (`icons/defaultIcons.js`)
+
+### `/themes/` – 🧪 Theme Stylesheets
+
+-   Includes variants like `dark.css`
+
+### `suneditor.js` – 🚪 Main Entry Point
+
+-   Bootstraps and exports the editor instance
+
+---
+
+## 🚀 Useful Commands
+
+```bash
+# Start local dev server
+npm run dev
+
+# Build for development
+npm run build:dev
+
+# Build for production
+npm run build:prod
+
+# lint
+npm run lint
+
+# Auto-fix JavaScript issues
+npm run lint:fix-js
+
+# Auto-fix TypeScript issues
+npm run lint:fix-ts
+
+# ✅ Run before committing!
+# Fix all lint issues (JS + TS)
+npm run lint:fix-all
+
+# Build types and update barrels
+npm run ts-build
+
+# Sync language files (base: en.js)
+npm run i18n-build
+
+# test
+npm run test
+```
+
+> [scripts/README](https://github.com/JiHong88/suneditor/blob/develop/scripts/README.md)
+
+---
+
+Thanks for contributing 💛
+You're helping make SunEditor better for everyone!
+
+```
+
+```

package/README.md

@@ -137,9 +137,18 @@ suneditor.create(document.querySelector('#editor'), {
 
 ---
 
+## 🔧 Framework Integration
+
+You can use the official wrappers for easier integration:
+
+React – [suneditor-react](https://github.com/JiHong88/suneditor-react)\
+Vue – [suneditor-vue](https://github.com/JiHong88/suneditor-vue)
+
+---
+
 ## 📦 Plugins
 
-SunEditor supports a plugin-based architecture.
+SunEditor supports a plugin-based architecture.\
 You can enable only the plugins you need or even create your own custom ones.
 
 ```js
@@ -153,6 +162,9 @@ suneditor.create('#editor', {
 
 📘 [Learn how to build your own plugin →](https://suneditor.com/plugins)
 
+🤖 Want to build plugins? Get real-time help from [SunEditor Devs AI](https://chatgpt.com/g/g-JViNPCrkD-suneditor-devs).\
+See [Contribution Guide](./CONTRIBUTING.md#ai-plugin-helper) for tips and examples.
+
 ---
 
 ## ✨ Contributors