Opened 11 years ago

Closed 10 years ago

#2435 closed Task (fixed)

Move CKEditor prototype to trunk

Reported by: Frederico Caldeira Knabben Owned by: Frederico Caldeira Knabben
Priority: Must have (possibly next milestone) Milestone: CKEditor 3.0
Component: General Version:
Keywords: Confirmed Cc:

Description

This is an umbrella ticket. It points to several tickets that must be completed and reviewed to properly move the CKEditor prototype to the CKEditor trunk.

Prototype SVN

The prototype can be checked out from the following URL:
https://svn.fckeditor.net/CKEditor/branches/prototype

The Review Process

Each ticket will identify a set of files that are under review, or even specific functions. We'll not have the usual patches on those tickets. The files are to be grabbed from the prototype branch.

The review keywords (Review?, Review+ and Review-) will continue to be used here. The ticket will be closed on Review+ (by the original developer), just like a usual commit operation.

The reviewer may make direct changes to the branch code if he feels it is ok. In such case, he should point out that some parts of the code are ok, but changes should be made, pointing to the changeset that included the changes, explaining them. At this point, the ticket must also have Review+, but the original developer must review the reviewer changes to ensure they are correct before closing the ticket. If anything is wrong, further changes are to be committed and Review? is called again, here again pointing to the changeset with explanations. This process should be repeated until all parts are satisfied with the results.

Things to Review

  • Specifications: the idea behind the feature must be good. The ODE documentation may be used as a reference, but can also be questioned.
  • Functionality: the code must do what it's intended to do.
  • Coding Style: the syntax must respect our Coding Style Guidelines. Don't be afraid to correct small things, like a space before a semicolon, or extra tabs.
  • Performance Optimizations: our code must run as fast as possible. Here again, micro-optimizations are welcome.
  • Code Simplification: less code is (usually) better. If something can be done in a simpler way, we must do it in that way.
  • API Documentation: our entire code must be properly documented. The reviewer is invited to enhance it if needed.
  • Tests: each single piece of the code must have well written tests to ensure its efficiency. If the present tests are not enough, the reviewer should explain that the code looks good, but the tests are not. The reviewer is invited to write missing tests.

Current Development

The prototype will be on continuous development during the review process. It will be moved to the trunk as a whole, as soon as this ticket gets closed. The development over the prototype branch will end then.

If the development touches code that has already been reviewed, its relative ticket must be reopened and the review must be requested again, possibly pointing to the changeset that introduced the changes to be reviewed. If the review request is open, changes must be added to a comment, so the reviewer can get notified of it.

Tickets Under Review

Several keywords will be used to identify tickets that are under review. These keywords will group the tickets in the following lists:

Structural and Development Features

#519
JavaScript API documentation
#880
Organize the code in namespaces
#1504
License header review
#2441
V3: Samples
#2442
V3: trunk folders/files structure
#2445
V3: Private variable and functions in the code

Base Features

#2437
V3: Environment and browser information
#2444
V3: Utility functions
#2446
V3: Event System
#2447
V3: DOM abstraction
#2448
V3: XML handling object
#2449
V3: Ajax like data requests handling object

Core Features

#2453
V3: Code loading
#2454
V3: Instances creation
#2456
V3: Editor instances
#2457
V3: Configurations
#2458
V3: Plugins
#2459
V3: Skins
#2460
V3: Themes
#2475
V3: Globalization

Plugins

No results

Other

#2477
V3: Packager

Change History (3)

comment:1 Changed 11 years ago by Frederico Caldeira Knabben

Priority: NormalHigh

comment:2 Changed 10 years ago by Frederico Caldeira Knabben

Owner: set to Frederico Caldeira Knabben
Status: newassigned

Ok, I'm working on this move right now. The code will be reviewed as part of the moving process.

comment:3 Changed 10 years ago by Frederico Caldeira Knabben

Resolution: fixed
Status: assignedclosed
Note: See TracTickets for help on using tickets.
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy