Changes between Version 28 and Version 29 of TicketSpecs


Ignore:
Timestamp:
Mar 22, 2011, 9:27:27 AM (8 years ago)
Author:
Anna Tomanek
Comment:

Text enhancement and proof-reading

Legend:

Unmodified
Added
Removed
Modified
  • TicketSpecs

    v28 v29  
    33= Ticket Specs =
    44
    5 Reporting tickets can be very tricky if you are doing it for the first time. In some cases users unwillingly put too much or too little information about a bug or a new feature and as a result the ticket handling process extends. That is why we have placed some recommendations about every ticket field to help you understand more about ticket reporting.
     5Reporting tickets can be very tricky if you are doing it for the first time. In some cases users unwillingly put too much or too little information about a bug or a new feature and as a result the ticket handling process extends in time. That is why we have placed some recommendations about each of the ticket report fields to help you understand more about ticket reporting.
    66
    7 If you follow these recommendations you will help us to speed up the ticket handling process and in this way your request will be settled faster.
     7If you follow these recommendations, you will help us to speed up the ticket handling process and in this way your request will be able to be settled faster.
    88
    9 == Short summary ==
     9== Summary ==
    1010
    11 In this field the reporter should place a short summary about the ticket. If possible the reporter should put the name of the browser in which a new bug has occurred or in which a new feature is requested, in the beginning of the summary. Of course if the reported problem is found in every browser you don't have to put anything in the beginning of the field.
     11In this field the reporter should place a short, descriptive summary about the issue. If needed, the reporter should give the name of the browser in which a new bug has occurred or for which a new feature is requested, in the beginning of the summary. If the reported problem is found across different browsers this information is not needed.
    1212
    1313=== Examples ===
     
    1515{{{ IE: The sampleposteddata pages are not wrapping the "Value" column }}}
    1616
    17 {{{ Safari: objects are not selectable }}}
     17{{{ Safari: Objects are not selectable }}}
    1818
    1919{{{ FF3 : Content "flashing" on load }}}
     
    2121== Type ==
    2222
    23 This field is used for choosing the type of the ticket. You can choose from:
     23This field is used for choosing the type of the ticket. You can choose between:
    2424
    25 - '''Bug''' - if you found that something isn't working properly in CKEditor or in our other projects
     25- '''Bug''' - if you found that something is not working properly in CKEditor or other CKSource projects
    2626
    27 - '''New Feature''' - when you want to make a request for something new to be added to any of our project
     27- '''New Feature''' - when you want to request a new feature to be added to any of our projects
    2828
    29 - '''Task''' - tasks are usually used by CKEditor core development team to specify "things that should be done" which aren't related to Bug and New Feature. So generally we don't recommend to use this type by reporters.
     29- '''Task''' - tasks are usually used by CKEditor core development team to specify "things that should be done" which are not related to Bug and New Feature. Generally we do not recommend external reporters to use this type.
    3030
    31 == Full description ==
     31== Description ==
    3232
    33 The '''Full description''' field is the most important field in creating a new ticket. Its content allows our team to know with what kind of problem the reporter is dealing with. There are a few tips that the reporter should now about when filling this field.
     33The '''Description''' field is the most important field when creating a new ticket. Its content allows our team to know with what kind of problem the reporter is dealing with. There are a few tips that the reporter should take into account when filling this field.
    3434
    35 Every issue must be confirmed by someone from our core development team.
    36  - When it comes to confirming ''new features'' we just check if the request is valid and possible to be implemented or not.
    37  - When it comes to ''bugs'' the things aren't so easy because we must reproduce the bug. Sometimes it is very hard to be done because of lack of the information that the reporter is providing. So besides the bug description we recommend to write a '''step by step instruction''' for reproducing the bug.
     35Each issue must be confirmed by someone from our core development team.
     36 - When it comes to confirming ''new features'', we just check if the request is valid and possible to be implemented or not.
     37 - When it comes to confirming ''bugs'', things are not so easy because we must reproduce the bug. Sometimes it can be hard because of lack of information that the reporter is providing. So apart from the bug description we recommend to provide a '''step-by-step instruction''' for reproducing the bug.
    3838
    39 It is also essential to write what kind of browser or browsers the reporter is using when finding the bug e.g. IE, Firefox; what is the browser version and also what kind of operating system the reporter is using e.g. MAC, Linux, Vista. It could be done by adding 'Keywords' into field described below.
     39It is also essential to describe the environment that the reporter is using, i.e. give the name of the browser or browsers (IE, Firefox, etc.); browser version (IE8, Firefox 3.6, Opera 11), the operating system (MAC, Linux, Windows Vista). This information can also be added by entering keywords into the '''Keywords''' field described below.
    4040
    4141=== Example ===
    4242
    43 The following example will show you a full description regarding all the necessary data:
     43The following example will show you a full description containing all the necessary data:
    4444
    4545{{{
    46  When pasting a large image from Word by using "Paste from Word" and
     46 When pasting a large image from Microsoft Word by using "Paste from Word" and
    4747 highlighting it in the PfW window, the frame of the image goes outside the
    48  window area
     48 window area.
    4949
    5050 Steps to reproduce:
    5151  1. Copy a big image from Word using CTRL+C (the picture should be bigger
    5252 than the "Paste from Word" window.
    53   2. Go to CKEditor and open "Paste from Word"
     53  2. Go to CKEditor and open the "Paste from Word" dialog window.
    5454  3. Paste the image into the window.
    55   4. Click on the image so it is highlighted
     55  4. Click the image to highlight it.
    5656  5. You will see that the image frame is outside the window.
    5757 
     
    6262
    6363=== Priority ===
    64 This option is usually disabled for reporters. It allows us to segregate the most important issues from the least important ones.
     64This option is usually disabled for reporters. It allows us to separate the most important issues from the least important ones.
    6565
    66 By default, the priority is set to '''Normal'''. The '''High''' and '''Low''' options are set after new issue is confirmed, to know what Bugs/New Features we should deal with firstly. That is why every ticket is reviewed by someone from the core development team, who sets its priority due to its importance.
     66By default, the priority is set to '''Normal'''. The '''High''' and '''Low''' options are set after new issue is confirmed, to know what Bugs/New Features we should deal with firstly. That is why each ticket is reviewed by someone from the core development team, who sets its priority according to its importance.
    6767
    6868=== Milestone ===
    69 This option is disabled for reporters. Even if enabled, we recommend no to use this option by reporters and leave this setting for developers.
    70 Milestone option is used by the core development team for targeting Bugs and New Features. So for example, if we have confirmed a bug and someone has began fixing it, we set the Milestone to specify what version will be free of this bug e.g. 'CKEditor 3.5'. 
     69This option is disabled for reporters. Even if enabled, we recommend the reporters not to use this option and leave this setting for the core developers.
     70The Milestone option is used by the core development team for targeting Bugs and New Features. If, for example, we have confirmed a bug and someone began fixing it, we set the Milestone to specify which release will be free of this bug e.g. ''CKEditor 3.5.3''. 
    7171
    7272=== Component ===
     73Component is an option which allows the reporter to specify in what part of the program the bug occurred, or for what part of the program a New Feature is requested. If, for example, you have a problem with the context menu, you set the Component to ''UI : Context Menu''.
     74A detailed list of components is maintained on the '''[wiki:Components Components]''' page. [[BR]]
     75If you are not sure what kind of component to choose, just leave it as ''General''.
    7376
    74 Component is an option which allows to specify in what part of the program the bug occurred, or for what part of the program a New Feature is requested for. So for example: if you have a problem with a context menu you set the Component to ''UI : Context Menu''.
    75 Detailed list of components is maintained on '''[wiki:Components Components]''' page. [[BR]]
    76 If you are not sure what kind of component to choose just leave it as ''General''.
    77 
    78 '''Note''': There are two options in the list that regard to CKEditor sister projects: '''CKPackager''' and '''MediaWiki+FCKEditor''' so if you have a problem with one of them simply choose one of these options.
     77'''Note''': The list also contains some CKEditor sister projects, like ''CKPackager'',''CKReleaser'', ''CKLangTool'', and ''MediaWiki+FCKEditor'', so if you have a problem with one of them simply choose one of these options.
    7978
    8079=== Version ===
    81 
    82 This option allows the reporter to specify in which version of CKEditor or FCKEditor a bug occurred. If you have found a bug in two versions, remember to always choose the 'older' version of the program. That way we can determine the origin of the bug.
     80This option allows the reporter to specify in which version of CKEditor or FCKEditor a bug '''first''' occurred. If the bug can be confirmed for more versions, remember to always choose the older version of the program. That way we can determine the origin of the bug.
    8381
    8482=== Keywords ===
     83The '''Keywords''' field is a powerful and important feature. CKEditor core development team uses it to gain information about a ticket, including browser details, current status, and ticket quality. Someone from our team always sets the keywords when a bug is reported, we also recommend the users to fill the {{{Browser}}} and {{{Operating System}}} keywords. The reporter can always check what kind of keywords we have used and in this way he or she can see what the current status of the ticket is and where the problem occurs.
    8584
    86 The "Keywords" field is a powerful and important feature. CKEditor core development team uses it to gain information regarding a ticket, including browser details, current status and ticket quality. Someone from our team always sets the keywords when a bug is reported, we also recommend the users to fill {{{Browser}}} and {{{Operating System}}} keywords. The reporter can always check what kind of keywords have we used and in this way he or she can see what is the current status of the ticket and where the problem occurs.
     85Please note that the Keywords field should not be used for adding arbitrary tags that describe the issue. While filing tickets, use the pre-defined keywords ''only''.
    8786
    88 Example: '''[query:keywords~=Mac&keywords~=Safari MAC Safari]'''
     87Example: '''[query:keywords~=Mac&keywords~=Safari Mac Safari]'''
    8988
    9089The following is the list of standard keywords that we use. The keyword name is always "PascalCased" with no spaces:
     
    9291----
    9392
    94 '''Environment''' [[BR]]
    95 In most of cases, Windows operating system is used, so there is no need for adding keyword. For other operating systems there are keywords defined: [[BR]]
    96    - '''[query:keywords~=Mac Mac]'''  for tickets which come from Mac
    97    - '''[query:keywords~=Linux Linux]'''  for tickets coming from Linux
    98 For tickets, which come from operating systems other than Linux, Mac and Windows, please describe your environment in ''Full description'' field. [[BR]]
     93'''Operating System''' [[BR]]
     94In most of cases, Windows operating system is used, so there is no need for adding a special keyword for that. For other operating systems the following keywords are defined: [[BR]]
     95   - '''[query:keywords~=Mac Mac]'''  for issues that occur on Mac
     96   - '''[query:keywords~=Linux Linux]'''  for issues that occur on Linux
     97For issues that occur in operating systems other than Linux, Mac, and Windows, please describe your environment in the ''Description'' field. [[BR]]
    9998
    100 '''Browser Specific''' [[BR]]
     99'''Browser''' [[BR]]
    101100
    102101
    103 '''Gecko'''     Marks tickets that are related to Gecko compatible browsers only. Possible keywords are:
     102'''Gecko''' - Marks tickets that are related to Gecko-based browsers only. Possible keywords are:
    104103                - '''[query:keywords~=Gecko Gecko]''' for all Gecko browsers including Firefox, Flock, Camino, etc.
    105104                - '''[query:keywords~=Firefox Firefox]''' for all Firefox versions
    106                 - '''[query:keywords~=Firefox2 Firefox2]''', '''[query:keywords~=Firefox3 Firefox3]''', '''[query:keywords~=Firefox4 Firefox4]''' for specific versions
     105                - '''[query:keywords~=Firefox2 Firefox2]''', '''[query:keywords~=Firefox3 Firefox3]''', '''[query:keywords~=Firefox4 Firefox4]''' for specific Firefox versions
    107106                                 
    108 '''Opera'''     '''[query:keywords~=Opera Opera]''' Marks tickets that are related to Opera browsers only.
     107'''[query:keywords~=Opera Opera]''' - Marks tickets that are related to Opera browser only.
    109108
    110 '''IE'''       Marks tickets that are related to Internet Explorer only. Possible keywords are:
    111                 - '''[query:keywords~=IE IE]''' for all Internet Explorer versions,
    112                 - '''[query:keywords~=IE6 IE6]''', '''[query:keywords~=IE7 IE7]''', '''[query:keywords~=IE8 IE8]''' '''[query:keywords~=IE9 IE9]'''for specific versions of Internet Explorer
     109'''IE''' - Marks tickets that are related to Internet Explorer only. Possible keywords are:
     110                - '''[query:keywords~=IE IE]''' for all Internet Explorer versions
     111                - '''[query:keywords~=IE6 IE6]''', '''[query:keywords~=IE7 IE7]''', '''[query:keywords~=IE8 IE8]''' '''[query:keywords~=IE9 IE9]''' for specific versions of Internet Explorer
    113112
    114 '''Webkit'''    Marks tickets that are related to Webkit compatible browsers only. Possible keywords are:
    115                 - '''[query:keywords~=Webkit Webkit]''' for all browsers, based on Webkit engine
     113'''Webkit''' - Marks tickets that are related to WebKit-based browsers only. Possible keywords are:
     114                - '''[query:keywords~=Webkit Webkit]''' for all browsers based on the WebKit engine
    116115                - '''[query:keywords~=Chrome Chrome]''' for all Chrome or Chromium versions
    117116                - '''[query:keywords~=Chrome5 Chrome5]''', '''[query:keywords~=Chrome6 Chrome6]''', '''[query:keywords~=Chrome7 Chrome7]''' for specific Chrome versions
    118                 - '''[query:keywords~=Safari Safari]'''
     117                - '''[query:keywords~=Safari Safari]''' for all Safari versions
    119118----
    120119
    121120'''Core Developers Activity'''
    122121
    123    - '''[query:keywords~=Discussion Discussion]''' - Tickets that need more discussion to understand the expected behavior, its correct interpretation, the correct way of handling then, etc...   
     122   - '''[query:keywords~=Discussion Discussion]''' - Tickets that need more discussion to understand the expected behavior, its correct interpretation, the correct way of handling them, etc.
    124123   - '''[query:keywords~=HasPatch HasPatch]''' - Tickets that contains a "valid" (checked by a core developer) proposal patch attached to it. A [report:9 dedicated report] has been created for it.
    125    - '''[query:keywords~=Review+ Review+]''' - If the patch attached to the ticket is ready to commit
    126    - '''[query:keywords~=Review- Review-]''' - When patch added to the ticket is not ready to commit (has bugs or coding style is incorrect.
    127    - '''[query:keywords~=Refactoring Refactoring]''' - Tickets are connected with code refactoring to improve code quality
     124   - '''[query:keywords~=Refactoring Refactoring]''' - Tickets related to code refactoring whose purpose is to improve the overall code quality
    128125   
    129126
     
    131128
    132129'''Archived keywords'''
    133 Keywords that are no longer in use (replaced by Trac statuses), but added to older tickets.
     130Keywords that are no longer in use (replaced by Trac statuses), but could be added to older tickets.
    134131
    135  - '''[query:keywords~=Confirmed Confirmed]''' for "Bugs", it indicates that a core developer was able to confirm the bug in some way, validating the ticket. For "New Features" and "Tasks", it indicates that the ticket has been reviewed and its has been understood as a valid request. It's not there to indicate our intentions on working on the ticket though.
    136  - '''[query:keywords~=Pending Pending]''' Marks tickets that need more information to be correctly understood or even reproduced. A [report:10 dedicated report] has been created to easily identify expired tickets (pending for more than 30 days).
    137  - '''[query:keywords~=SF SF]''' Marks tickets that has been originally created at SourceForge and then transfered to this site.
    138  - '''[query:keywords~=WorksForMe WorksForMe]''' Indicates that a core developer has tried to reproduce the problem with no success, having the expected results instead.
     132 - '''[query:keywords~=Confirmed Confirmed]''' for "Bugs", it indicates that a core developer was able to confirm the bug in some way, validating the ticket. For "New Features" and "Tasks", it indicates that the ticket has been reviewed and it has been understood as a valid request. It is not there to indicate our intentions on working on the ticket though.
     133 - '''[query:keywords~=Pending Pending]''' - Marks tickets that need more information to be correctly understood or even reproduced. A [report:10 dedicated report] has been created to easily identify expired tickets (pending for more than 30 days).
     134 - '''[query:keywords~=Review+ Review+]''' - When the patch attached to the ticket has passed the review and is ready to be committed.
     135 - '''[query:keywords~=Review- Review-]''' - When the patch added to the ticket has failed the review and is not ready to be committed (contains bugs or the coding style is incorrect).
     136 - '''[query:keywords~=SF SF]''' - Marks tickets that have originally been created at SourceForge and then transfered to this site.
     137 - '''[query:keywords~=WorksForMe WorksForMe]''' - Indicates that a core developer has tried to reproduce the problem with no success, having the expected results instead.
    139138
    140139----
    141140
    142141=== Assign to ===
    143 This option is ''disabled'' for reporters. It is used by the development team to specify who will fix the bug or who will handle a new feature. We recommend reporters '''not to use this field''' at all. This field should be only used to gain information about the tickets status. So if you see that a ticket has been assigned it means that someone has began working with it.
     142This option is ''disabled'' for reporters. It is used by the development team to specify who will fix the bug or who will handle a new feature. We recommend reporters '''not to use this field''' at all. This field should only be used to gain information about the tickets status. So if you see that a ticket was assigned, it means that someone began working on it.
    144143
    145144== Attachments ==
    146 
    147 The last option in the ticket opening process is adding an attachment. If you want to add an attachment check the "I have files to attach to this ticket" box. After submitting the ticket you will be asked for the attachment. 
     145The last option in the ticket creation process is adding an attachment. If you want to add an attachment, check the "I have files to attach to this ticket" box. After submitting the ticket you will be asked to provide an attachment. 
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy