#2435: Move CKEditor prototype to trunk
-----------------------+----------------------------------------------------
Reporter: fredck | Owner:
Type: Task | Status: new
Priority: Normal | Milestone: CKEditor 3.0
Component: General | Version:
Keywords: Confirmed |
-----------------------+----------------------------------------------------
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:[[BR]]
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
[http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture 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
[http://docs.fckeditor.net/FCKeditor_3.x/Design_and_Architecture/Coding_Style
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 ====
[[TicketQuery(keywords~=V3ProtoStruct&order=id)]]
==== Base Features ====
[[TicketQuery(keywords~=V3ProtoBase&order=id)]]
==== Core Features ====
[[TicketQuery(keywords~=V3ProtoCore&order=id)]]
==== Plugins ====
[[TicketQuery(keywords~=V3ProtoPlugins&order=id)]]
==== Other ====
[[TicketQuery(keywords~=V3ProtoOther&order=id)]]
--
Ticket URL: <http://dev.fckeditor.net/ticket/2435>
FCKeditor <http://www.fckeditor.net/>
The text editor for Internet
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
FCKeditor-Trac mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/fckeditor-trac
