wiki:CKEditor-Tests.git

Working on ckeditor-tests.git

Cloning the repository

The very first step to start working on our tests is having your local copy of the repository:

git clone git@git.ckeditor.com:ckeditor-tests.git
init_repo.sh

The above will also perform some basic recommended initialization on your local clone.

Working on an existing ticket branch

While working on tickets, it is a common task to deal with tickets tests, having to run, analyze, enhance or review tests. To setup an existing ticket branch locally, just execute the following:

work_on_ticket.sh <ticket>

Creating a new ticket branch

To create a brand new ticket tests branch, just execute the following:

open_ticket.sh <ticket>

Merging a ticket branch

Once a t/<ticket> branch is passing and stable, and the ticket is fixed and closed, it is time to move it to master. That can be easily accomplished by executing the following:

merge_ticket.sh <ticket>

Conventions

Ticket branches names follow the "t/<ticket>" pattern.


When committing anything on a ticket branch, always prefix the commit message with "#<ticket> : ". For example:

#123 : Added basic tests.
#6543 : Added new dt tests for core/tools.
#3456 : Fixed typos on the test steps.

When new tests are created for a ticket, a ticket comment must be added, pointing to their URL. Usually, further comments are not necessary. For example:

http://ckeditor.t/tt/123/1.html
http://ckeditor.t/tt/123/2.html

Comments may be used to inform the reasoning for some tests to be written:

After some investigation, I found out that the issue is relative to a bug on CKEDITOR.tools. I've added a new tc for it:
http://ckeditor.t/dt/core/tools.html
The TC described at comment:2 is covered by this new test:
http://ckeditor.t/tt/123/3.html
© 2003 – 2011 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy