doc/contributing

   1 * Contributing to the Mono project
   2
   3         There are many ways in which you can help in the Mono project:
   4
   5         <ul>
   6                 * <b>Programmers:</b> You can work on a free
   7                   implementation of the <a
   8                   href="class-library.html">class libraries</a>, the
   9                   <a href="runtime.html">runtime engine</a>, <a
  10                   href="tools.html">the tools</a>, the <a
  11                   href="testing.html">testing framework</a>
  12
  13                 * <b>Writers:</b> You can help us bywriting <a
  14                   href="documentation.html">documentation</a>.
  15         </ul>
  16
  17         Those are just broad things that need to be worked on, but
  18         something that would help tremendously would be to help with
  19         small duties in the project that need to be addressed.
  20
  21         You can see what needs to be done in the class libraries <a href="class-status.html">here</a>
  22
  23 ** To start contributing
  24
  25         As a programmer, you can contribute in three different scenarios to Mono:
  26
  27         <ul>
  28                 * If you only have Linux/Unix.
  29                 * If you only have Windows.
  30
  31                 * If you have both Linux and Windows.
  32         </ul>
  33
  34         You might also want to check our <a href="#setup">common
  35         setups</a> section that describes some common setups that people
  36         use while working on Mono.
  37
  38 *** Contributing to the class library, regression tests or the compiler
  39
  40         This only requires Windows currently.
  41
  42         To start developing classes or to contribute to the compiler,
  43         you only need Windows and the .NET Framework 1.0 SDK.  Please notice
  44         that you do not need Visual Studio (although you can use it if
  45         you want).  The .NET Framework SDK requires some version of
  46         Windows XP or Windows NT.  If you are running Windows 98, 95
  47         or Me, you could use instead the <a
  48         href="http://msdn.microsoft.com/downloads/default.asp?url=/downloads/sample.asp?url=/msdn-files/027/001/829/msdncompositedoc.xml">.NET Redist package</a>, but it
  49         lacks the documentation browser and the ildasm program (C#, VB, JScript and IL
  50         assembler are included).
  51
  52         You can get it <a href="http://msdn.microsoft.com/downloads/default.asp?url=/downloads/sample.asp?url=/msdn-files/027/000/976/msdncompositedoc.xml&frame=true">here</a>
  53
  54         If you are new to .NET, writing regression tests is a good way
  55         of starting to contribute: it will help you get used to C# as
  56         well as getting comfortable with the .NET APIs.
  57
  58         This helps because at this point you might be the best
  59         qualified person to fix a problem found by the regression
  60         test, or you might have a new class to implement in the .NET
  61         world that only has a test suite.
  62
  63         To get started writing tests see the <a href="testing.html">Test Suite</a>
  64         section. <a href="mono-contribution-howto">Here</a> there is a good All-In-One introduction to the art of writing tests.
  65
  66
  67 *** Contributing to the runtime engine
  68
  69         This only requires Linux, currently some tasks are easier if you
  70         have access to Windows as well.
  71
  72         Here are a few things you can do:
  73         <ul>
  74                 * Port the runtime to other architectures.
  75                 * Port the runtime to other operating systems.
  76                 * Finish the IL code verifier in the runtime.
  77                 * Hack the JIT, improve the code generator, add new
  78                   pattern rules, improve the register allocator.
  79                 * Implement the debugging interfaaces
  80         </ul>
  81
  82 ** Bug reporting
  83
  84         If you find bugs in Mono, please make sure you enter a bug
  85         report so we can keep track of problems in Mono.
  86
  87         To enter bug reports go to <a href="http://bugzilla.ximian.com">
  88         http://bugzilla.ximian.com</a> and enter bug reports against
  89         your favorite component (Mono, Runtime, C# compiler).
  90
  91         You can review the list of current bugs by going <a href="http://bugzilla.ximian.com/buglist.cgi?product=Mono%2FClass+Libraries&product=Mono%2FMCS&product=Mono%2FRuntime&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&short_desc=&short_desc_type=substring&long_desc=&long_desc_type=substring&bug_file_loc=&bug_file_loc_type=substring&keywords=&keywords_type=anywords&op_sys_details=&op_sys_details_type=substring&version_details=&version_details_type=substring&cmdtype=doit&order=%27Importance%27&form_name=query">here</a>
  92
  93 ** Small tasks
  94
  95         A few smaller tasks are here, dropped in no particular order:
  96         <ul>
  97                 * <b>Mono/doc and web site:</b> They need to be
  98                   packaged up in the official `distribution'
  99
 100                 * Adding serialization support to all the classes.
 101
 102                   We have many classes, but we have not implemented in
 103                   many cases the serialization and re-incarnation support in
 104                   them (this is pretty straight forward code, and simple,
 105                   but there is a lot to be done here).
 106         </ul>
 107
 108 * Emacs support
 109
 110         Brad Merryl's C# mode for Emacs is available: <a
 111         href="http://www.cybercom.net/~zbrad/DotNet/Emacs/">http://www.cybercom.net/~zbrad/DotNet/Emacs/</a>
 112
 113 * Books on C# and DotNet.
 114
 115         <ul>
 116         * Dotnet Books (<a href="http://www.dotnetbooks.com">http://www.dotnetbooks.com</a>)
 117
 118         * Dotnet Resources (<a href="http://www.dotnetexperts.com/resources/">
 119           http://www.dotnetexperts.com/resources</a>)
 120
 121         * O'Reilly C# Essentials (<a href="http://www.oreilly.com/catalog/csharpess/">
 122           http://www.oreally.com/catalog/csharpess</a>)
 123
 124         * O'Really .NET Essentials (<a href="http://www.oreilly.com/catalog/dotnetfrmess/">
 125           http://www.oreally.com/catalog/dotnetfrmess</a>)
 126         </ul>
 127
 128 <a name="setup">
 129 * Common Setups
 130
 131         People running both Linux and Windows while contributing to
 132         Mono use a number of tricks to increase their productivity.
 133
 134         Scenarios:
 135
 136         <ul>
 137                 * <b>Linux host and Windows host</b>
 138
 139                   The Windows file system is shared (right click on
 140                   your hard drive icon, and select sharing, allow this
 141                   to be shared).
 142
 143                   The Windows machine has the required build tools
 144                   (cygwin, and the .NET framework).  On the Windows
 145                   machine, you want to setup the ssh server (run the
 146                   ssh-host-config program to configure your ssh) and
 147                   run it (from a cygwin terminal, type: /usr/sbin/sshd).
 148
 149                   From the Linux side, you want to mount the Windows
 150                   file system, using something like this:
 151
 152 <tt><pre>
 153         mount -t smbfs -o uid=miguel,username="Miguel de Icaza" "//quack/c$" /mnt
 154 </pre></tt>
 155
 156                   In the above example, my Linux user name is
 157                   `miguel', and this will allow this user to have
 158                   read/write access to the share.
 159
 160                   The host name is `quack', and the name of the share
 161                   is `c$' (that is the C: partition).
 162
 163                   The file system is accessible on /mnt.
 164
 165                   You can perform your cvs update and cvs commits from
 166                   the /mnt directory, and run Emacs or your favorite
 167                   Linux text editor on the Unix side in this way.
 168
 169                   Then from another terminal, you can ssh into your
 170                   Windows box using ssh, like this: ssh "Miguel de Icaza@quack"
 171         </ul>
 172
 173 * Special Note
 174
 175         If you have looked at Microsoft's implementation of .NET or
 176         their shared source code, you may not be able to contribute
 177         to Mono.  Details will follow when we know more about this.
 178
 179         In general be careful when you are implementing free software
 180         and you have access to proprietary code.  We need to make sure
 181         that we are not using someone else's copyrighted code
 182         accidentally.
 183
 184         Please do not use the <b>ildasm</b> program to disassemble
 185         proprietary code when you are planning to reimplement a class
 186         for Mono.  If you have done this, we might not be able to use
 187         your code.
 188
 189         Please stick to published documentation for implementing any
 190         classes.