RIDLIssueGuide

Version 3 (Martin Corino, 04/12/2016 01:31 pm)

1 1 Martin Corino
h1. RIDL Issue submission guidelines
2 1 Martin Corino
3 1 Martin Corino
Submissions should be written in english.
4 1 Martin Corino
5 1 Martin Corino
h2. Submitting a Bug
6 1 Martin Corino
7 1 Martin Corino
Before submitting a bug report here, please make sure:
8 1 Martin Corino
9 1 Martin Corino
* that you're using an appropriately installed RIDL version (see [[RIDLPG_Ch2_IR|Installing RIDL]])
10 1 Martin Corino
* have a look at the bug list and the Forums to see if it has not already been reported/discussed
11 1 Martin Corino
12 1 Martin Corino
When filling a bug report, please give the following information with the description of your problem:
13 1 Martin Corino
14 1 Martin Corino
* your operating system (incl. version)
15 1 Martin Corino
* your Ruby version (eg. Ruby 1.8.7 or JRuby 1.6.0)
16 1 Martin Corino
* your RIDL version
17 1 Martin Corino
18 1 Martin Corino
h2. Submitting a Feature Request
19 1 Martin Corino
20 1 Martin Corino
Before submitting a feature request here, please make sure:
21 1 Martin Corino
22 1 Martin Corino
* fill the subject as a sum up of your description
23 1 Martin Corino
* fill the description as detailed as you can, don't hesitate to describe precisely how this feature should behave, try to add what benefits you're expecting from it
24 1 Martin Corino
* please DON'T fill the target version field: let the developers decide when integrate
25 1 Martin Corino
* please DON'T assign the feature request to anybody, let the developers deal with it
26 1 Martin Corino
27 1 Martin Corino
h2. Submitting a Patch
28 1 Martin Corino
29 1 Martin Corino
Submit as a Feature request. All the guidelines for submitting a Feature request apply.
30 3 Martin Corino
Changes should be submitted as a single patch file. Instructions for creating a patch can be found [[RIDLPatch|here]].
31 1 Martin Corino
You should mention the branch/revision your patch is based on and attach the patch file.
32 1 Martin Corino
33 1 Martin Corino
h2. Submitting a Wiki improvement (project members only)
34 1 Martin Corino
35 1 Martin Corino
When you edit a wiki page to improve its content, make sure that you fill the comment field with a descriptive summary of the changes you've made to the page. This way we'll be better able to "monitor" and "maintain" the quality of the actual wiki content.