MeGUI/Helping with MeGUI
From MeWiki
There are several ways you can help with MeGUI.
Contents |
[edit] Reporting bugs and suggesting features
You can report bugs on SourceForge using the SourceForge bug tracker. You don't need to register with SourceForge to do this, although registering will let you be notified about subsequent changes to the bug-report's status.
Additionally, you can request features on the SourceForge feature request tracker.
[edit] Help with documentation
This wiki is used by MeGUI as the documentation. By contributing to this wiki, you are improving the quality of MeGUI's help information. To get started, have a look at the reference manual, and see if you can fill in some of the empty pages there, as these pages are directly linked to by MeGUI.
[edit] Contributing code
Contributing code is always welcome, as it is the least work for the developers.
[edit] What to work on
To get some ideas for what you can work on, read through the bug reports or feature requests on the SourceForge tracker. If there is one you want to do, leave a comment there saying you are working on it, so that people don't duplicate efforts.
If there is a particular feature you want added to MeGUI and you want to work on it, great! But still add it to the tracker and leave a comment that you are working on it, so that people don't duplicate efforts.
[edit] The code itself
[edit] Getting the code
MeGUI is written in C# 2.0, and is held on a SourceForge Subversion (SVN) repository. To download the sources, you will need a Subversion client (TortoiseSVN is a good one). Then, just do a subversion checkout from
https://megui.svn.sourceforge.net/svnroot/megui/
and you will have the sources. Look in the trunk/ subdirectory for the interesting parts.
[edit] Compiling and editing the code
- A minimal setup for developing MeGUI is simply the .NET Framework 2.0 -- the same framework that is required to run MeGUI. With just that, you can compile MeGUI by running trunk/compile.bat. This works fine for some small changes, but it presents difficulties for larger changes, especially the GUI.
- Microsoft distributes a free version of Visual Studio 2005 called Visual Studio Express. This can open the MeGUI project file (trunk/MeGUI.csproj) without hassle, and makes editing a lot easier, because it has a GUI designer. You can get Visual Studio Express from http://msdn.microsoft.com/vstudio/express/ (make sure you download the C# one!).
- If you have the full version of Visual Studio 2005, you can use that. Just like the free version, you just open the MeGUI project file (trunk/MeGUI.csproj) and start editing.
[edit] Submitting code
The preferable way of submitting code is in a patch file, submitted to the SourceForge patch tracker. (If you are using TortoiseSVN, you can make these patches by right-clicking in the MeGUI folder and going TortoiseSVN->Create patch...). If possible, do a SVN Update to the most recent version before making the patch, to save the developers time on merging your patch with newer source.

