How to get TortoiseSVN working with our project

From Shadowrun: Awakened

TortoiseSVN (TSVN) is very easy to setup and use. It integrates directory with Windows, expanding the options in the explorer's context menus to include commands for Subversion repositories.

Install

TSVN is easy to download and install. It's just a standard Microsoft installer package.

1. Go to: http://tortoisesvn.net/downloads
2. Download 32 or 64 bit version as appropriate to your OS
3. Run installer and restart

Looking at the project

You now have TSVN installed. This gives you a set of extra options in your context-menu (right-click-menu) while using windows explorer. You can use these to pull down the project.

1. Right-click on some whitespace in any window, bringing up the context menu (this includes the desktop!)
2. You will see a "TortoiseSVN" option in the menu, hover over it
3. The expanded menu should have a "Repo-Browser" option, click it
4. In the ensuing dialog, enter "https://shadowrunmmo.svn.sourceforge.net/svnroot/shadowrunmmo" for the URL
5. The main window should refresh with the contents of our repository

You now have read access to our project, take a look around!

Pulling something down

Now that you can see the repository, you can download things from it.

1. In the main window of the "repo-browser", select a directory from our project. Most developers should choose "SRA_UDK_Development".
2. Right-click on it. In the context menu, choose "check-out" for that item, a new dialog will appear
3. For the option "checkout directory" fill-in or browse to your preferred location
4. Hit OK

The contents of the selected directory will download to your selected location. You will see it marked with a large green check sign, indicating it is being tracked by TSVN.

Syncing to the project

After you have your files for a while, they may no longer be the head revision. To sync them, just right-click the file/directory and select "SVN Update" from the context menu.

Making a Patch

A patch in Subversion is a a means of rolling up many changes to code into a single file. That file can then be sent to others, applied to their local files, and reviewed for quality. This enables newcomers to send code to existing members and have it applied to the repository, after quality control. Submitting patches is a great way to join the team and earn our trust so one day you can commit your changes autonomously. To make a patch with TSVN, follow these steps:

1. Modify the files as necessary to fix a problem or add a new feature
2. Back up to the file your root SVN directory is in. For example, if your root directory is "C:\SRA_UDK_Development", then navigate to your "C:\" directory. Verify that the directory's SVN icon is the red exclamation, which indicates tracked files have been changed.
3. Right-click on the SVN directory and click "SVN Update" to make one last sync with the repository.
4. If files were changed by this update, then build your code in Visual Studio and make sure it still works. This will save a lot of time for people receiving your code.
5. Right-click on the SVN directory, expand the "TortoiseSVN" sub-menu and click the "Create Patch..." entry
6. TSVN will show a dialog enumerating the changed files. Ensure those are the ones you want and click "OK"
7. TSVN will ask for a location to put the file. Choose some place easy to remember and click "Save".

The patch file should automatically open, showing you a summary of changes across all files. This file can then be posted on the forums or sent over e-mail to other contributors. They will review the code, then either apply the changes to source control or request improvements on it. Either way, you will have made the contributor excited to have another productive teammate and you'll be one step closer to having commit access to our repository.

Committing Changes

Committing changes requires you to have commit rights to the SVN repository through Sourceforge. If you do not have these rights, please use the technique for making patches described above.

1. Modify the files as necessary to fix a problem or add a new feature
2. Back up to the file your root SVN directory is in. For example, if your root directory is "C:\SRA_UDK_Development", then navigate to your "C:\" directory. Verify that the directory's SVN icon is the red exclamation, which indicates tracked files have been changed.
3. Right-click on the SVN directory and click "SVN Update" to make one last sync with the repository.
4. If files were changed by this update, build your code in Visual Studio and make sure it still works. This will save a lot of time for people sharing development duties.
5. Right-click on the SVN directory then click on "SVN Commit..." in the context menu
6. A dialog will popup enumerating files changed. Please examine this list carefully and ensure it contains only code files you changed.
7. Click OK and watch the changes upload to the repository.

A summary of changes submitted to the repository are e-mailed out periodically to everyone on the Sourceforge e-mail listing. Other developers who are interested in your work may look over your changes and offer suggestions. Please engage in dialogue to ensure continual improvement and communication in the code and in the team. Good job helping the game grow!