>-----Original Message----- >From: Konovalova, Svetlana [mailto:[EMAIL PROTECTED] >Sent: Thursday, November 09, 2006 2:33 PM >To: harmony-dev@incubator.apache.org >Subject: RE: [jira] Good issue resolution guideline (was: >[classlib]volunteer to supply patches for old JIRAs) > >Alexey, >Thank you so much for providing such a detailed review. > >>I'd change the heading "Reporting the Issue" to "Reporting an Issue", >or >omit article at all. > Well, both articles seem to be fine. Let it be "a/an"
Maybe just omit articles then? > >>"Create as small test case, as possible" sounds not very good. (The >comma >shouldn't be used here any way.) I think "Create a test case as >small as >possible" is better. What do you think? > +1 > >>The next item: "...about the steps to *reproduce* the bug". Using >>'reproduce' is more conventional than 'recreate' in this case. > Let it be "recreate" I'm still for 'reproduce' because a bug can be (non-)reproducible but not recreatable. Any other opinions? > >>And again extra comma: "...information about the failure, as possible: >>stack trace". You should remove it. Consider using bulleted list for >>enumeration here, I mean "stack trace, failure output..." might be >marked >up as list, how about it? >Sorry, my fault, I've overlooked it. The comma shouldn't be there. >IMHO we shouldn't use bulleted list in this case, since we do not >publish the complete list of necessary diagnostic information, but just >provide three examples. Suggest to leave it as it is. Yep, agree. > >>Another point is lists can't be part of paragraph in HTML, thus you >should >>remove the opening and closing tags of paragraph in the subsection. I >mean: >>+<subsection name="Reporting the Issue"> >>- <p> // remove it from file >>+<ol> >>... >> </ol> >>-<p> // remove it from file >>+</subsection> >+1, let's fix > >>subsection "Resolving *an* Issue". >>The first paragraph says "To close *an* issue, define its type first." >>We're on stage of resolving here yet, so it should be "To resolve an >>issue..." >Good catch! > >>There's no ending punctuation in the list "If reporter did not provide >a >patch to test:". >Thanks! Should be fixed. > >>Following, I'd re-write sentence like this: "If you have any concerns, >>discuss *them* (was: questions) on the...." >I'd say: "If you have any questions, discuss them... That's even better :) > >>IMHO, there are extra articles which should be omitted, however, I'm >not a >native speaker... >Sorry, I'm not with you here. IMHO they are used appropriately. I won't insist on changing this. It's just my impression. > > >>subsection "Closing *an* Issue". >>The first paragraph says we should define issue type first. I think the >>type is defined at the stage of resolving, thus it's better to use >another >word rather than 'define'. But nothing comes to mind at the >moment. >IMHO it's ok to say "define". Before closing the issue, the one should >know its type to choose the right way to deal with it, right? I'd leave >it as it is. > >>IIRC, non-bug difference issues are not closed. They are left open, to >>remind of the difference. Am I mistaken? >Well, I'm not sure, really...you might know better... > >>Oh, I've missed another place: >>"All _pacthes_, test, and fix should be..." >>Here the word *patch* is misspelled. To my mind, 'test and fix' explain >>which patches are meant, so this should be surrounded with commas, or >even >dashes (parentheses may be used as well). This change will make >the >sentence clearer: >>"All patches - test and fix - should be..." >I'd better say: >All patches, such as tests and fixes, should be.... Good! It's clearer. > >>I can create another patch which will incorporate my comments, if you >like. >Go ahead, if you want to. Otherwise, I'll be glad to finalize it. Please >let me know if you need my help. OK. I'll prepare patch update then. Thanks, Alexey. > > >Best regards, >Sveta > >-----Original Message----- >From: Ivanov, Alexey A [mailto:[EMAIL PROTECTED] >Sent: Thursday, November 09, 2006 1:33 PM >To: harmony-dev@incubator.apache.org >Subject: RE: [jira] Good issue resolution guideline (was: >[classlib]volunteer to supply patches for old JIRAs) > >>-----Original Message----- >>From: Konovalova, Svetlana [mailto:[EMAIL PROTECTED] >>Sent: Wednesday, November 08, 2006 7:01 PM >>To: harmony-dev@incubator.apache.org >>Subject: RE: [jira] Good issue resolution guideline (was: >>[classlib]volunteer to supply patches for old JIRAs) >> >> >>I've just submitted a new JIRA >>[http://issues.apache.org/jira/browse/HARMONY-2110]. >>I've added the necessary links from the website to the new page and >have >>tried to perfect it a little. >>It would be great, if you could find a chance to look through the >patch. >>Thanks in advance. > >Sveta, > >I've taken a look and added my comments to the JIRA itself. > > >Regards, >Alexey. > >> >>Best regards, >>Sveta >> >>-----Original Message----- >>From: Morozova, Nadezhda [mailto:[EMAIL PROTECTED] >>Sent: Wednesday, November 08, 2006 11:18 AM >>To: harmony-dev@incubator.apache.org >>Subject: RE: [jira] Good issue resolution guideline (was: >>[classlib]volunteer to supply patches for old JIRAs) >> >>Good! Go ahead. Do you need help? I can review the patch - just let me >>know when you submit the JIRA. >> >>Thank you, >>Nadya Morozova >> >>-----Original Message----- >>From: Konovalova, Svetlana [mailto:[EMAIL PROTECTED] >>Sent: Wednesday, November 08, 2006 9:13 AM >>To: harmony-dev@incubator.apache.org >>Subject: RE: [jira] Good issue resolution guideline (was: >>[classlib]volunteer to supply patches for old JIRAs) >> >>Nadya wrote: >>>Candidates: >>>http://incubator.apache.org/harmony/guidelines.html >>>http://incubator.apache.org/harmony/get-involved.html >>+1 >> >>>it's not quite convenient for me just now to add patches, so if >someone >>>volunteers to help, I'd be grateful. >>If you do not mind, I can create the necessary patches. >> >>Best regards, >>Sveta Konovalova >> >>-----Original Message----- >>From: Morozova, Nadezhda [mailto:[EMAIL PROTECTED] >>Sent: Tuesday, November 07, 2006 8:24 PM >>To: harmony-dev@incubator.apache.org >>Subject: RE: [jira] Good issue resolution guideline (was: >>[classlib]volunteer to supply patches for old JIRAs) >> >>Well, >>I guess the simplest solution would be to add the link to the >>Conventions section on the front page of wiki. You can do it yourself! >>Adding a link from the static website would also be useful. Candidates: >>http://incubator.apache.org/harmony/guidelines.html >>http://incubator.apache.org/harmony/get-involved.html >> >>it's not quite convenient for me just now to add patches, so if someone >>volunteers to help, I'd be grateful. >> >>Thank you, >>Nadya Morozova >> >> >>-----Original Message----- >>From: Alexey Petrenko [mailto:[EMAIL PROTECTED] >>Sent: Tuesday, November 07, 2006 4:44 PM >>To: harmony-dev@incubator.apache.org >>Subject: Re: [jira] Good issue resolution guideline (was: >>[classlib]volunteer to supply patches for old JIRAs) >> >>Nadya, >> >>we definetly need a link to this page. That's not a question. >>Question is where to place the link. >>And as I said in previous email link place suggestions are welcome. >> >>SY, Alexey >> >>2006/11/7, Morozova, Nadezhda <[EMAIL PROTECTED]>: >>> Alexey, >>> Would be great if there we some page that had a link to the page; >>> otherwise, you cannot find it from within wiki, only from the link in >>> your mail :( >>> >>> Thank you, >>> Nadya Morozova >>> >>> >>> -----Original Message----- >>> From: Alexey Petrenko [mailto:[EMAIL PROTECTED] >>> Sent: Tuesday, November 07, 2006 1:32 PM >>> To: harmony-dev@incubator.apache.org >>> Subject: Re: [jira] Good issue resolution guideline (was: >>> [classlib]volunteer to supply patches for old JIRAs) >>> >>> I've published "Good issue resolution guideline" on Harmony site: >>> http://incubator.apache.org/harmony/issue_resolution_guideline.html >>> (wait for a while for the web site synchronization). It is not linked >>> to other pages yet. >>> >>> So comments to guideline and link place suggestions are welcome. >>> >>> SY, Alexey ><SNIP> > >-- >Alexey A. Ivanov >Intel Enterprise Solutions Software Division -- Alexey A. Ivanov Intel Enterprise Solutions Software Division
