Added a readme for the newcomers.
[mono.git] / mcs / errors / CONTRIBUTORS_README
1
2         Mono MCS Errors contributors readme
3
4         Created: 01/14/2003. First revised:
5         
6   If you are willing to contribute to the errors tests,
7   you should follow the following procedure.
8
9         * Visit the URL: 
10         
11         http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cscomp/html/vctbsCompilerErrorsSC0001ThroughSC9999.asp
12         
13         We are writing at least one test per each error 
14         CSXXXX documented in that URL. So check the mcs/errors
15         directory for missing csXXXX.cs files, where a csXXXX.cs
16         file is a simple error test for a concrete bug.
17
18         * Contact raciel@gnome.org, jaime@gnome.org 
19         or the mono list: mono-list@ximian.com before you
20         start so we can provide you with a list of errors 
21         that are unassigned. Otherwise you might start
22         writing already assigned errors tests.
23
24         
25         
26         Template for an error test:
27
28         The file should be named: csXXXX.cs according to the
29         error number.
30
31         The file should start with two inline commented lines.
32         The first one contains a little description of the error.
33         You can't just copy it from Microsoft's documentation. 
34         Invent your own. 
35         The second line declares the line where the error occurs.
36         
37         F.ex: 
38         // cs0057.cs: Inconsistent accessibility. Parameter type is less accessible than operator.
39         // Line: 10
40
41         Then you can write the code for your test. You can also
42         add inline comments for the copyright, etc if you want
43         to. Look at the other tests for examples.
44
45         There shouldn't be two or more errors per tests. This is
46         you write a test for each error and the code shouldn't
47         have more errors than the one trying to show and that
48         appears at the line commented in the second line of the
49         file.
50
51         Then you have to add the file to the CVS and commit it.
52
53         The next thing is to write a short text file with a little
54         description of what the error is and what it's necessary
55         to be done to solve it. F.ex, if the error is that there 
56         is no entrypoint in the program, you could say:
57         "Error CSXXXX: no entrypoint defined. You need to specify
58         an entrypoint or compile with /target:library (F.ex.).
59         The file must be called csXXXX.txt
60
61