Code Repository Access
If you are a new developer, this page should be the first step in getting setup to work on the addon code. Simply follow the steps below.
Getting Setup on Curseforge
- Make a curse account.
- Talk to Sapu and get him to add you as an author on the module(s) you'll be working on.
- Log into your curse account on http://curseforge.com and go here: https://www.curseforge.com/home/repository-authorization/
- Click on "Edit".
- All you need to do is set an SVN password. An SSH key is not required and should be left blank. Read curseforge's warning message at the top of the page.
- Curseforge is the developer side of curse so get used to it if you aren't already.
- Go to the project page for one of the modules you're working on and you should see yourself listed as an author.
- Click on the "Repository" tab and take note of the 2nd SVN url listed (the top "Development URL" one). You'll need this URL later.
TortoiseSVN only works for Windows. If you're not using Windows, you should talk to Sapu about how to get setup.
- Download TortoiseSVN here.
- Follow the prompts to install it. Nothing special here.
Checking Out the Code
- Go into your "World of Warcraft/Interface/Addons" folder and delete the folder of the addon you'll be checking out.
- Right click in the Addons folder and select "SVN Checkout...".
- In the "URL of repository:" box, enter the url you got from curseforge in the previous step. The format of the url should be like this: "svn://<USERNAME>@svn.curseforge.net/wow/<ADDON_SLUG>/mainline/trunk".
- In the "Checkout directory:" box, replace "mainline" with the addon name. For example, "..\AddOns\TradeSkillMaster_Accounting".
- Everything else in this box should be left as the default values. Hit OK. Once it finishes, you should see a new folder in your Addons folder for that addon you just checked out.
Committing (Checking In) Changes
- Do a reasonable amount of testing on the change you made to make sure there are no obvious errors.
- In your Addons folder, right click on the folder of the addon you made the change too (there should be a red '!' in the folder icon meaning it's been changed).
- In the "Message:" field, type in a brief message about what you did. While these messages won't be seen by users, it will be viewed by other developers trying to figure out when a certain change was made or compiling a list of changes for the changelog so make it count but be concise.
- Make sure all the checkboxes are checked in the list of files. By default, TortoiseSVN won't check the boxes next to new files that were added or files that were removed. You can double click on a file in this list to view a diff between your version and the current version in the repo.
- Hit OK. If this is your first time, you'll have to enter your username and password. Remember that this is your SVN password that you set above, not your curseforge password. You didn't make them the same did you? ;)