harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Alexey A. Ivanov (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HARMONY-2110) Good issue resolution guideline
Date Thu, 09 Nov 2006 08:22:39 GMT
    [ http://issues.apache.org/jira/browse/HARMONY-2110?page=comments#action_12448391 ] 
            
Alexey A. Ivanov commented on HARMONY-2110:
-------------------------------------------

I have some corrections to the text, patch.

I'd change the heading "Reporting the Issue" to "Reporting an Issue", or omit article at all.

"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?

The next item: "...about the steps to *reproduce* the bug". Using 'reproduce' is more conventional
than 'recreate' in this case.

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?

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>


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..."

There's no ending punctuation in the list "If reporter did not provide a patch to test:".

Following, I'd re-write sentence like this: "If you have any concerns, discuss *them* (was:
questions) on the...."

IMHO, there are extra articles which should be omitted, however, I'm not a native speaker...


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.

IIRC, non-bug difference issues are not closed. They are left open, to remind of the difference.
Am I mistaken?


I can create another patch which will incorporate my comments, if you like.
Thank you for work! We'll have a better site.

> Good issue resolution guideline
> -------------------------------
>
>                 Key: HARMONY-2110
>                 URL: http://issues.apache.org/jira/browse/HARMONY-2110
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Website/Documentation
>            Reporter: Svetlana Konovalova
>         Assigned To: Alexey Petrenko
>         Attachments: IssueResolutionGuideline.patch
>
>
> add links from the website to the new "Good issue resolution guideline" page. brush up
the page

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message