How to submit LuxRender issues

News & Announcements regarding releases, features, exporters and project coordination.

Moderators: Dade, coordinators

How to submit LuxRender issues

Postby jromang » Fri Dec 28, 2007 4:33 am

So you have spotted an issue with LuxRender ; this is the first step to make your renderer a better piece of software ;)
Next, you will have to report this using the bug tracking system : http://www.luxrender.net/mantis . This is a quick guide on how to do it !
To submit bug reports, you have to create a new account in the bug tracking system, so we know who exactly has been reporting the bugs. It shouldn't be too much of a hassle. After that, here are the steps :

1. Choose a Category

Once you have selected the appropriate project then your first task is to select the category to which your issue applies. Take a look at the list available in the Category drop down list (at 1 in the picture). If you are unable to find one simply choose 'Any' and at a later time someone will recategorize it creating a new category if necessary.

2. Indicate the Reproducibility of the Issue

One useful piece of information concerns the difficulty of reproducing the issue. Try to make an appropriate choice to the best of your ability from the Reproducibility drop-down list (at 2 in the picture). If this is not a bug then 'N/A' is probably the appropriate choice.

3. Pick a Severity

Next try to give some idea of how important you believe this issue is. Choose a designation from the Severity drop-down list (at 3 in the picture).
If you are reporting a bug you will generally choose from 'minor', 'major', or 'crash'. Only choose 'crash' if the issue causes the renderer to exit catastrophically.
If you are submitting a fix or an enhancement you will choose either from the list for bugs or from 'feature', 'text', 'tweak'. If you are submitting an enhancement that adds a new feature then choose 'feature'. If you are correcting a textual typo or perhaps adding just a small amount of new text then choose 'text'. If you adjusting an existing feature but not fixing a bug then choose 'tweak'. If you think your submission is truly trivial then feel free to select 'trivial'.
The 'block' choice is generally used by the developers to designate an issue that must be fixed before the next release. This is a difficult decision to make and in general a reporter will not use this designation.

4. Select a Priority

In general you do not need to select a priority and the default choice of 'normal' is fine.

5. Indicate the Product Version

This is optional and not even available for all projects. The version here refers to the version of Lux to which this issue relates. If this field is available then select the version of Lux you saw the bug in or to which your attachment applies from the drop-down list (at 5 in the picture).

6. Provide a Short Summary

Think of this field like the Subject of an email. Write a very short one line description of the issue.

7. Describe the Issue in Detail

This is probably the most important field of the entire form. In the Description field (at 7 in the picture) you will describe in as much detail as possible either the problem you have discovered or the fix or enhancement you are providing.
If you are reporting a bug it is very important that the developers understand how to reproduce the issue. Give as much detail as you can about the environment in which you experienced the problem:

* What platform and operating system were you running Lux on?
* What version of Lux/Exporter were you using?
* What scene do you have loaded?

If you can please try to reproduce the issue in the very latest available (CVS) version.
Next describe the steps you took that led to the issue. Be detailed. And of course as clearly as you can describe the problem.
If you are providing a fix for a problem either refer to another Mantis issue by its ID number where the issue is described or describe it in complete detail yourself as discussed above. Alternatively you might find it simpler to just add your fix to the original report and not fill out a new report. Of course if you do so please add any additional information that you have in the note.
If this is an enhancement then describe how it would be used. Feel free to present your argument as to why you feel that your enhancement should be incorporated into a future version.

8. Provide any Additional Information

The Additional Information field (at 8 in the picture) is optional but is where additional information such as a debug log can be provided.

9. Attach a File to the Issue

This is also optional but of course if you are providing a fix or enhancement then it should be attached here (at 9 in the picture).
You can attach images, scene files, etc (zipped).

10. Finally

Ignore the 'View Status' field and unless you have another issue to report you can skip the 'Report Stay' field (if you do just check the checkbox) and hit the 'Submit Report' button.
You're Done! Thank you for your report and all your future reports. ;)
Attachments
theform.png
User avatar
jromang
Developer
 
Posts: 557
Joined: Wed Sep 19, 2007 2:41 am

Re: How to submit Lux issues

Postby akhenathon » Mon Dec 29, 2008 10:40 am

http://www.luxrender2.org/mantis
This is not a valid URL.

http://www.luxrender.net/mantis
It asks for username/password.

----
Claudio Malagrino
Fantasyart
http://www.fantasyart.com.br
akhenathon
 
Posts: 78
Joined: Wed Oct 15, 2008 9:34 am
Location: Sao Paulo, Brazil

Re: How to submit Lux issues

Postby jeanphi » Mon Dec 29, 2008 11:31 am

Hi,

luxrender2.org is the old domain name that has now been replaced with luxrender.net

In order to access the mantis bug tracker, you have to register an account, that's why it asks for a user/password (there should be a link to register).

Jeanphi
jeanphi
Developer
 
Posts: 7943
Joined: Mon Jan 14, 2008 7:21 am


Return to News & Announcements

Who is online

Users browsing this forum: No registered users and 1 guest