If you feel you are ready for a CVS account send an e-mail to
<a href="mailto:miguel@ximian.com">miguel</a> with your public OpenSSH
- key for this purpose. Please specify if the key was generated with SSH
- version 1 or version 2. Detailed instructions are below.
+ key for this purpose. We only support SSH2 at this point.
* Policies
have a sort of unofficial ownership. If you are not the owner of a
piece of code and you want to make changes/fixes to it, there are two
cases.
- 1) The change is a typo fix or a one-liner build or trivial fix. In
+
+ <ul>
+ <li> The change is a typo fix or a one-liner build or trivial fix. In
this case almost anyone can commit (always remembering to add the
proper changelog entry to explain the change). We say "almost anyone",
because changes to certain directories almost always should be reviewed
first. Such as changes to core stuff: corlib/System, System.Collections,
mini/, metadata/, System.IO.
- 2) The change is larger. In this case the patch *must* be sent to
+ <li> The change is larger. In this case the patch *must* be sent to
mono-devel-list for review by the owner of the code and by the other
hackers. Always submit such patches to the list or bugzilla, although
you may put the owner of the code in the CC header. Hackers come and go.
Mailing a patch to only a personal address is a good way to get the
patch forgotten and missed. Plus, getting the patches reviewed as well
as reviewing them, is a good thing, so try to get used to it.
+ </ul>
Note: If the patch is an addition of code and doesn't change any of the
existing code, the rules are slightly relaxed: there is more freedom
Once you know you can commit a patch (because of the rules above) there
are a few other small rules to follow:
+
<ul>
- <li>Always add a changelog entry with a meaningful explanation
+ <li>Always add a ChangeLog entry with a meaningful
+ explanation, this file should be located in the same directory
+ as the change you make.
+
+ <li>The ChangeLog entry <b>must</b> be pasted on the CVS
+ commit log, so the CVS commit log can be used to map to the
+ changes as well.
+
+ <li>The ChangeLog and the files that comprise related changes
+ should be committed together, not one by one, otherwise the
+ history is pretty much useless if related changes are
+ separated during the commit.
+
<li>If you fix a bug, add a regression test for it in the regression
- suite
+ suite.
+
<li>Don't commit unrelated changes together with a fix: do fine-grained
- commits
+ commits.
+
<li>Always check what you're committing: make sure you're only committing
what you need and make sure you don't change line endings and
- whitespace. Do a 'cvs diff -u' of the files you're going to commit and
+ whitespace. Do a 'cvs diff -u' of the files you're going to commit and
check the changes.
+
<li>Don't do reformatting commits, unless you're the original author of
- the code
+ the code.
+
<li>When fixing bugs, don't follow the documentation blindly, it may
well be wrong. Test the behavior on the MS runtime or ask on the list
for discussion if unsure. Don't be afraid of having your changes
reviewed.
- <li>Never remove copyright notices from the code
- <li>Never remove licensing info from code
+
+ <li>Never remove copyright notices from the code.
+
+ <li>Never remove licensing info from code.
+
<li>Never commit code you didn't write yourself or code that doesn't
- have a suitable license
- <li>Follow the style conventions
+ have a suitable license.
+
+ <li>Follow the style conventions.
+
<li>Keep an eye on performance considerations, especially for code in
- core classes, ask on the list for guidance
+ core classes, ask on the list for guidance.
+
<li>Do a regression test run and a bootstrapping build if making changes
to core functionality before committing. Do not commit code that would
break the compile, because that wastes everybody's time. Two things
are important in this step: trying to build your sources and making
sure that you add all the new files before you do a commit.
+
</ul>
Also, remember to pat yourself on the back after the commit, smile and
think we're a step closer to a better free software world.
+* Branches
+
+ We have branched the CVS modules `mono', `mcs' and
+ `libgdiplus', the tag to fetch these branches is: `mono-1-0',
+ so you use the following command to fetch the mono-1-0
+ branches:
+
+<pre>
+ cvs co -r mono-1-0 mono
+ cvs co -r mono-1-0 mcs
+ cvs co -r mono-1-0 libgdiplus
+</pre>
+
+ I personally use a directory called `mono-1-0' to keep these
+ together and a separate directory keeps my HEAD development,
+ and I configure each one to different prefixes, so I can test
+ and run code with HEAD or mono-1-0.
+
+*** mono-1-0 policy
+
+ This branch will only get bug fixes to critical and major errors.
+ You must still get approval from the maintainer of the code to
+ check-in code into this branch.
+
+ Before submitting a patch for this branch, you should run all
+ appropriate regression tests. Upcoming mono-1.0.x versions
+ will be produced from this branch.
+
+*** mono HEAD policy
+
+ HEAD should continue to build at all times: HEAD is not a
+ dumping ground for partial work: you still must ensure that
+ the build is not broken, and that no regressions are caused.
+ Unlike the main branch, you do not need approval to minor
+ changes, the same old rules apply.
+
+ But for any large architectural change, you must check with
+ the maintainers and get approval for the patches. For these
+ large changes, if you are touching someone else's code, you
+ should contact the maintainer of that code and get approval
+ from them.
+
+ You must assume that HEAD will be packaged and distributed at
+ any point, this will be the branch that we use for making the
+ mono-1.1.x releases that will lead to our stable mono-1.2.x
+ release.
+
+ So, the bottom line is: do not check-in known regressions that
+ break the build. A lot of work is underway, and we must
+ ensure the tree works.
+
* Using CVS.
cvs commit file-1.cs file-2.cs
</pre>
+* Using SVN
+
+ This is a small tutorial for using SVN (subversion).
+ For a more complete tutorial on subversion, look at
+ <a href="http://svnbook.red-bean.com/">the svn book</a>
+ or <a href="http://subversion.tigris.org">the svn homepage</a>
+
+** Generating a key
+
+ Follow the cvs instructions above.
+
+** Checking out the sources
+
+ To checkout the sources for the first time use the command:
+
+ Note: You should be running 0.35.1 (latest) of svn before attempting
+ anything here.
+
+<pre>
+ svn co svn+ssh://mono-cvs.ximian.com/svn/monodevelop/trunk/MonoDevelop
+</pre>
+
+ If you have a different username on mono-cvs and the local computer
+ you can do the following:
+
+<pre>
+ svn co svn+ssh://username@mono-cvs.ximian.com/svn/monodevelop/trunk/MonoDevelop
+</pre>
+
+ before checking out.
+
+** Updating your sources
+
+ You can update your repository to the latest copy of MonoDevelop by
+ running the following command:
+
+<pre>
+ svn up
+</pre>
+
+ from inside your repository.
+
+** Committing your work
+
+ Before you commit anything, you should first update to the latest
+ sources by following the updating directions. After you are up to date
+ you need to run a:
+
+<pre>
+ svn add filename
+</pre>
+
+ for every file that you have created. You can get a list of these files
+ by running:
+
+<pre>
+ svn status
+</pre>
+
+ After all the files are added, run:
+
+<pre>
+ svn commit
+</pre>
+
+ to commit your changes.
+
+** For more information
+
+ Look at the MonoDevelop website (coming soon)
+
* Keeping track of changes.
We provide two e-mail based mechanisms to keep track of
projects / mono.git / blobdiff