CKEditor 4 Documentation

Issues Tracker Site

CKEditor issues are handled through the GitHub issues page since the CKEditor 4.7 release (May 25th, 2017). The former tracking system is still available in the read-only mode and all past issues are still available publicly.

The issues page is used daily by the CKEditor core team to organize and distribute the development workflow. It is also the right place to report issues.

Before you attempt to report an issue, please make sure you read this page and thus help us optimize the management of issues.

Required Information

Please provide the following when reporting new issues. The more information you provide, the quicker the problem may be solved:

  • Descriptive summary – A "right to the point" phrase that best summarizes the issue that you are having.
  • Steps to reproduce – This is the most important thing. We are not able to fix an issue if we cannot see it with our own eyes. A numbered list of actions to reproduce the issue is invaluable.
  • Browser name and OS – Your computer configuration, OS, browser name and version.
  • Editor configuration – Your editor version, integration method, editor build (you can attach your build-config.js file).
  • Screenshot – For interface-related issues an image speaks more than thousands of words.
  • Sample data – For content-related issues please attach a sample file from which we can get the text for testing.
  • Test case file – If possible, attach a test case file showing the issue. This is the best way to show us the problem and make it quicker to solve.

Important

When filing an issue, please bear these important things in mind:

  • Submit separate reports for each issue. Do not include more than one issue in the same report.
  • Make sure you are using the latest CKEditor version. Maybe your issue has already been fixed.
  • Follow the instructions in the issue template when reporting an issue.

Reporting an Issue

Before clicking the following link, make sure you have read the instructions above!

Only registered GitHub users may create issues. If you are not registered, take a minute to create a GitHub account.

This is it. Once you log in, you will be ready to report a CKEditor issue.

Labels

Every issue may be marked with the following labels:

  • Status labels – current issue status:
    • status:pending – More information is needed to proceed with the issue.
    • status:confirmed – Issue confirmed by the development team.
  • Type labels - the type of the issue:
    • type:bug – A bug.
    • type:feature – A feature request.
    • type:task– Any other issue (refactoring, typo fix, etc).
  • Resolution labels – how and why the issue was resolved:
    • resolution:invalid – Not a valid issue (not reproducible, 3rd-party bug, etc).
    • resolution:duplicate – A duplicate of an already reported issue.
    • resolution:wontfix – The issue is valid, however CKSource does not plan to fix it.
    • If the issue is closed and there is no resolution label, it means that the issue was fixed and merged to the master/major branch.
  • Browser labels – for browser-specific bugs:
    • browser:NNN – The issue can only be reproduced in a particular browser.
  • Other - additional information:
    • support – An issue reported by a commercially licensed client.
    • easy – Relatively easy to fix, this is a perfect issue if you are willing to create a Pull Request.