Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.18 KB

CONTRIBUTE.md

File metadata and controls

45 lines (27 loc) · 1.18 KB

Contribute to the project

Learn how to make a ckeditor plugin

See https://ckeditor.com/docs/ckeditor4/latest/guide/plugin_sdk_sample.html

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker!

Contributing

We welcome contributions to this project. Please see our contribution guidelines for details.

Installation from source

  1. Clone the repository.
  2. Install pnpm with npm install -g pnpm.
  3. Install the dependencies with pnpm install.
  4. Run development server with pnpm dev.
  5. Adjust openai credentials in index.html or copy this file to have a gitignored test-page.
  6. If you want to create final dist-folder use pnpm build.

Create pull request

  1. Create a new branch for your changes.
  2. Commit your changes.
  3. Push your changes to your fork.
  4. Create a pull request.

License

Licensed under the terms of the GNU General Public License, version 3 or later.

Submit a ckeditor plugin

  1. go to https://ckeditor.com/cke4/addon
  2. click on "Submit a plugin"
  3. fill out the form
  4. click on "Submit"
  5. wait for approval