Changes between Version 18 and Version 19 of TicketSpecs


Ignore:
Timestamp:
Aug 31, 2010, 8:36:23 AM (9 years ago)
Author:
Krzysztof Studnik
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TicketSpecs

    v18 v19  
    3333The '''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.
    3434
    35 Every bug or a new feature must be confirmed by someone from our core development team. When it comes to confirming new features we just check if the request is valid and possible to be implemented or not. 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.
     35Every 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.
    3638
    37 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.
     39It 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.
    3840
    3941=== Example ===
     
    6769=== Milestone ===
    6870
    69 This 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. FCKeditor 2.7 .
    70 
    71 We recommend no to use this option by reporters and leave this setting for developers. However there are two exception for this recommendation.
    72 
    73 The reporter is allowed to set the Milestone to '''Opera Compatibility''' and '''Safari Compatibility''' if a Bug or a New Feature regards specifically to Opera and Safari browsers, so you can use this Milestones when something isn't working or should be done '''only''' in those browsers.
     71This 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'. We recommend no to use this option by reporters and leave this setting for developers.
    7472
    7573=== Component ===
     
    7775Component 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''. If you are not sure what kind of component to choose just leave it as ''General''.
    7876
    79 '''Note''': There are two options in the list that regard to FCKeditor sister projects: '''FCKpackager''' and '''MediaWiki+FCKeditor''' so if you have a problem with one of them simply choose one of these options.
     77'''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.
    8078
    8179=== Version ===
    8280
    83 This option allows the reporter to specify in which version of 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.
     81This 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.
    8482
    8583=== Keywords ===
    8684
    87 The "Keywords" field is a powerful and important feature. FCKeditor 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, so we recommend the users '''not to use this field''' at all. 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.
     85The "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.
     86
     87Example: '''[query:keywords~=Windows&keywords~=IE Windows IE]'''
    8888
    8989The following is the list of standard keywords that we use. The keyword name is always "PascalCased" with no spaces:
    9090
    91 {{{
    92 #!rst
     91----
    9392
    94 ================ =============================================================================
    95 **Browser Specific**
    96 ----------------------------------------------------------------------------------------------
    97 **Firefox**      (`[query:keywords~=Firefox Tickets]`:trac:)
    98                  Marks tickets that are related to Gecko compatible browsers only (not only
    99                  Firefox).
     93'''Environment''' [[BR]]
    10094
    101 **IE**           (`[query:keywords~=IE Tickets]`:trac:)
    102                  Marks tickets that are related to Internet Explorer only.
     95   - '''[query:keywords~=Windows Windows]''' for tickets discovered under Windows OS.
     96   - '''[query:keywords~=MacOS MacOS]'''  for tickets which come from Mac
     97   - '''[query:keywords~=Linux Linux]'''  for tickets coming from Linux
     98   - '''[query:keywords~=OtherOS OtherOS]''' for tickets, which come from operating systems other than above. [[BR]]
    10399
    104 **IE7**          (`[query:keywords~=IE7 Tickets]`:trac:)
    105                  Marks tickets that are related to Internet Explorer version 7.x only.
    106 ---------------- -----------------------------------------------------------------------------
     100'''Browser Specific''' [[BR]]
    107101
    108 ----------------------------------------------------------------------------------------------
    109 **Core Developers Activity**
    110 ----------------------------------------------------------------------------------------------
    111 **CantFix**      (`[query:keywords~=CantFix Tickets]`:trac:)
    112                  Indicates that the ticket is looking for something that is almost impossible
    113                  (or excessively hard) to be achieved or fixed.
    114102
    115 **Confirmed**    (`[query:keywords~=Confirmed Tickets]`:trac:)
    116                  For "Bugs", it indicates that a core developer was able to confirm the bug
    117                  in some way, validating the ticket.
    118                  For "New Features" and "Tasks", it indicates that the ticket has been
    119                  reviewed and its has been understood as a valid request. It's not there to
    120                  indicate our intentions on working on the ticket though.
     103'''Gecko'''     Marks tickets that are related to Gecko compatible browsers only. Possible keywords are:
     104                - '''[query:keywords~=Gecko Gecko]''' for all Gecko browsers including Firefox, Flock, Camino, etc.
     105                - '''[query:keywords~=Firefox Firefox]''' for all Firefox versions
     106                - '''[query:keywords~=Firefox2 Firefox2]''', '''[query:keywords~=Firefox3 Firefox3]''', '''[query:keywords~=Firefox4 Firefox4]''' for specific versions
     107                                 
     108'''Opera'''     '''[query:keywords~=Opera Opera]''' Marks tickets that are related to Opera browsers only.
    121109
    122 **HasPatch**     (`[query:keywords~=HasPatch Tickets]`:trac:)
    123                  Tickets that contains a "valid" (checked by a core developer) proposal patch
    124                  attached to it.
    125                  A `[report:9 dedicated report]`:trac: has been created for it.
     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~=IE7 IE7]''', '''[query:keywords~=IE7 IE7]''', '''[query:keywords~=IE7 IE7]''' for specific versions of Internet Explorer
    126113
    127 **Discussion**   (`[query:keywords~=Discussion Tickets]`:trac:)
    128                  Tickets that need more discussion to understand the expected behavior, its
    129                  correct interpretation, the correct way of handling then, etc...
     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
     116                - '''[query:keywords~=Chrome Chrome]''' for all Chrome or Chromium versions
     117                - '''[query:keywords~=Chrome5 Chrome5]''', '''[query:keywords~=Chrome6 Chrome6]''', '''[query:keywords~=Chrome6 Chrome6]''' for specific Chrome versions
     118                - '''[query:keywords~=Safari Safari]'''
     119----
    130120
    131 **Pending**      (`[query:keywords~=Pending Tickets]`:trac:)
    132                  Marks tickets that need more information to be correctly understood or even
    133                  reproduced.
    134                  A `[report:10 dedicated report]`:trac: has been created to easily identify
    135                  expired tickets (pending for more than 30 days).
     121'''Core Developers Activity'''
    136122
    137 **SF**           (`[query:keywords~=SF Tickets]`:trac:)
    138                  Marks tickets that has been originally created at SourceForge and then
    139                  transfered to this site.
     123   - '''[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.
     124   - '''[query:keywords~=Discussion Discussion]''' - Tickets that need more discussion to understand the expected behavior, its correct interpretation, the correct way of handling then, etc...
    140125
    141 **WorksForMe**   (`[query:keywords~=WorksForMe Tickets]`:trac:)
    142                  Indicates that a core developer has tried to reproduce the problem with no
    143                  success, having the expected results instead.
    144 ================ =============================================================================
    145 }}}
     126----
     127
     128'''Archived keywords'''
     129Keywords that are no longer in use (replaced by Trac statusses), but added to older tickets.
     130
     131 - '''[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.
     132 - '''[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).
     133 - '''[query:keywords~=SF SF]''' Marks tickets that has been originally created at SourceForge and then transfered to this site.
     134 - '''[query:keywords~=WorksForMe WorksForMe]''' Indicates that a core developer has tried to reproduce the problem with no success, having the expected results instead.
    146135
    147136----
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy