harmony-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Konovalova, Svetlana" <svetlana.konoval...@intel.com>
Subject RE: [jira] Good issue resolution guideline (was: [classlib]volunteer to supply patches for old JIRAs)
Date Wed, 08 Nov 2006 12:23:37 GMT
Alexey wrote:
>Do we really need a smiley in the header: "Resolution Provider :)"?

Of course not, since it's not just a friendly correspondence:) suggest
to remove.

>AFAIK, for headings one should use Title Capitalization, i.e. first
>letter of each word is capitalized with exception for articles,
>prepositions, and conjunctions. Or am I wrong?

You are absolutely right here. 

>And another comment. Will it be better to use different numbering in
>lists? I mean like this:
>1. Issue is probably a non-bug...
>	a. Discuss on dev-list.
>	b. Add a link...
>2. Issue is a bug:
>	a. Notify the community...
>	b. If reporter did not provide a patch to test...

I, personally, do not see any reason why not to use different numbering.
For such complex lists, we usually use numbers for the first level and
bullets for the second one.
Speaking about the "Good issue resolution guideline" page, I'd rewrite
it to get rid of complex lists and to avoid a sort of confusion:

If the issue is not a bug, ...:
   1. Discuss on dev-list.
   2. Add a link...

If the issue is a bug,...:
   1. Notify the community...
   2. If reporter did not provide a patch to test...

What would you say?

By the way, I'm going to create a patch to add links from the website
to this page. If you do not mind, I can correct the page as well in
between times... how about that?

Best regards,
Sveta Konovalova

-----Original Message-----
From: Ivanov, Alexey A [mailto:alexey.a.ivanov@intel.com] 
Sent: Wednesday, November 08, 2006 1:50 PM
To: harmony-dev@incubator.apache.org
Subject: RE: [jira] Good issue resolution guideline (was:
[classlib]volunteer to supply patches for old JIRAs)

Hi,

Do we really need a smiley in the header: "Resolution Provider :)"?

AFAIK, for headings one should use Title Capitalization, i.e. first
letter of each word is capitalized with exception for articles,
prepositions, and conjunctions. Or am I wrong?

Does anyone mind to mark up file names (build.xml) and paths
(https://svn.apache.org/...) in monospaced font using <code> tags?

Is it worth making repository path a link?

And another comment. Will it be better to use different numbering in
lists? I mean like this:
1. Issue is probably a non-bug...
	a. Discuss on dev-list.
	b. Add a link...
2. Issue is a bug:
	a. Notify the community...
	b. If reporter did not provide a patch to test...


Any comments?


Regards,
--
Alexey A. Ivanov
Intel Middleware Product Division


>-----Original Message-----
>From: Alexey Petrenko [mailto:alexey.a.petrenko@gmail.com]
>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
>
>2006/9/28, Geir Magnusson Jr. <geir@pobox.com>:
>>
>> On Sep 28, 2006, at 3:21 AM, Alexey Petrenko wrote:
>>
>> > Guys,
>> >
>> > Since there is no additional comments on this guideline...
>> >
>> > Let's put it somewhere.
>> > We got two options: Harmony site and wiki.
>> > I prefer wiki because it will be easy to edit it and I can put it
>> > there myself :)
>>
>> And if you put in a patch for website, we can get it there too :)  if
>> you put in wiki, I'm going to take and put on site, so maybe save us
>> some effort? (ok, save me the effort...)
>>
>> geir
>>
>> >
>> > Thoughts?
>> >
>> > SY, Alexey
>> >
>> > 2006/9/26, Alexey Petrenko <alexey.a.petrenko@gmail.com>:
>> >> I've combined all the comments again.
>> >>
>> >> And here is the last version. I hope... :)
>> >>
>> >> === cut ===
>> >> Preface
>> >> This guideline covers a wide range of issues but not all of them.
>> >> If you cannot do one of the steps, then write a comment to the
issue.
>> >> Use your common sense!
>> >>
>> >> Issue reporter:
>> >> 1. Explicitly state the expected behavior and the
>> >> actual behavior of Harmony code. Use links to specs, rfcs, etc.
>> >> 2. Try to create as small a test case as possible. A patch
>> >> to test will be highly appreciated.
>> >> 3. Provide max. information about steps necessary to recreate the
>> >> bug.
>> >> If a patch for the test has not been supplied, provide as much
>> >> diagnostic information about the failure as possible (stack trace,
>> >> failure output, expected output etc).
>> >> 4. Remember to use issue links if applicable.
>> >> 5. Check the issue resolution when it is committed. Add a comment.
>> >>
>> >> Resolution provider :) :
>> >> Depending on the type of issue, do the following:
>> >>
>> >> 1. Issue is probably a non-bug difference, not a bug or invalid:
>> >>   1.1. Discuss on the dev list.
>> >>   1.2. Add a link to the discussion thread as a comment to issue.
>> >> 2. Issue is a bug:
>> >>   2.1. Notify the community that you started investigation by
adding
>> >> a comment to the issue and send a message to dev list. If you
cannot
>> >> produce a patch, add another comment with the results of your
>> >> investigation.
>> >>   2.2. If reporter did not provide a patch to test:
>> >>       2.2.1. Try to create a patch to test.
>> >>       2.2.2. If you cannot produce a patch, write a comment about
it.
>> >>   2.3. Create a patch to fix the issue
>> >>       2.3.1. Any concerns? Discuss on the dev list. Add a link to
>> >> discussion as a comment.
>> >>   2.4. All the pacthes (test and fix) should be relative to the
>> >> directory where the main build.xml is:
>> >> https://svn.apache.org/repos/asf/incubator/harmony/enhanced/
>> >> classlib/trunk.
>> >> Or to the module root directory.
>> >>   2.5. Test and fix patches should be in different files.
>> >>   2.6. If the patch requires to add, remove or move some files in
the
>> >> repository, add the appropriate script.
>> >>   2.6. Check that all unit tests pass.
>> >>   2.8. If it is an application-oriented issue, check the
application.
>> >>   2.9. Remember to use issue links if applicable.
>> >>
>> >> Committer:
>> >> Depending on the issue type, do:
>> >> 1. Issue is a non-bug difference, not a bug or invalid:
>> >> Close the issue.
>> >> 2. Issue is a bug:
>> >>   2.1. If a patch to test is available, apply it.
>> >>   2.2. Check that the test fails.
>> >>   2.3. Apply the fix for the issue.
>> >>   2.4. Check that test succeeds now.
>> >>   2.5. Make sure that all unit tests pass.
>> >>   2.6. For application-oriented issues, check the application.
>> >>   2.7. If there are problems on previous steps, post a comment to
>> >> JIRA and let "resolution provider" to resolve.
>> >>   2.8. Make sure that the issue reporter is happy with the
>> >> resolution.
>> >>   2.9. Add revision info into JIRA issue
>> >> === cut ===
>> >>
>> >
>> >
>> > --
>> > Alexey A. Petrenko
>> > Intel Middleware Products Division
>> >
>> >
---------------------------------------------------------------------
>> > Terms of use : http://incubator.apache.org/harmony/mailing.html
>> > To unsubscribe, e-mail:
harmony-dev-unsubscribe@incubator.apache.org
>> > For additional commands, e-mail:
harmony-dev-help@incubator.apache.org
>> >
>>
>>
>> ---------------------------------------------------------------------
>> Terms of use : http://incubator.apache.org/harmony/mailing.html
>> To unsubscribe, e-mail: harmony-dev-unsubscribe@incubator.apache.org
>> For additional commands, e-mail:
harmony-dev-help@incubator.apache.org
>>
>>

Mime
View raw message