Changes between Version 8 and Version 9 of Development/NewDeveloperGuide
- Timestamp:
- 08/17/11 20:45:17 (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Development/NewDeveloperGuide
v8 v9 18 18 Instructions on how to get started with the source code are in our [../GettingStarted Getting Started guide]. 19 19 20 Once you have the source code you can build and use WarFoundry, but can't commit changes back to the project. If you want to help out and make changes then please contact IBBoard (either [http://forums.hiveworldterra.co.uk/memberlist.php?mode=viewprofile&u=2 through the forums] or [http://ibboard.co.uk/contact.php his website]) to get your Trac account promoted to a "developer" account and a Subversion account created.20 Once you have the source code you can build and use WarFoundry, but can't commit changes back to the project. If you want to help out and make changes then please contact IBBoard (either [http://forums.hiveworldterra.co.uk/memberlist.php?mode=viewprofile&u=2 through the forums] or [http://ibboard.co.uk/contact.php his website]) to get your Trac account promoted to a "developer" account. To commit code then just create an account on the [http://dev.ibboard.co.uk/repos/ Repository Manager] and fork your own personal copy of the code. 21 21 22 22 == What can I help with? == … … 26 26 == I'm new to using source control - how do I use it? == 27 27 28 It depends on what platform you're on. In Windows you'll need something like [http://rapidsvn.tigris.org/ RapidSVN] or [http://tortoisesvn.tigris.org/ TortoiseSVN]. In Linux there is a wide variety of alternatives, including [http://rapidsvn.tigris.org/ RapidSVN], [http://www.anrichter.net/projects/qsvn/ QSvn] and [http://zoneit.free.fr/esvn/ eSVN] amongst [http://en.wikipedia.org/wiki/Comparison_of_Subversion_clients others]. [http://monodevelop.com MonoDevelop] also has built-in support for Subversion repositories.28 It depends on what platform you're on. We've got a page listing [../GettingStarted/MercurialClients Mercurial version control clients]. 29 29 30 Once you've got a source control client, you need to "c heck out" the project, such as svn://svn.ibboard.co.uk/warfoundry/IBBoard.WarFoundry.GUI.GTK/trunk to get a copy of the trunk (latest development version) of the GTK# interface for WarFoundry. This can be done anonymously for all WarFoundry projects (you don't need to be a registered user) and takes a copy of the code and stores it on your machine to work with. To get the full application working you'll need to [wiki:Development/GettingStarted#Gettingthesourcecode check out the appropriate projects] and create a project from them.30 Once you've got a source control client, you need to "clone" the projects to get a full copy of the code and all of its history that you can work with. This can be done anonymously for all WarFoundry projects using the username {{{default}}} and the password {{{default}}}. To get the full application working you'll need to check out [wiki:Development/GettingStarted#Gettingthesourcecode all of the appropriate projects]. 31 31 32 If you want to make changes and share them back to the project then you can either make them locally, create a patch (MonoDevelop has a built-in feature to do this) and attach it to a [/query ticket] or you can ask for permission to "commit" to the Subversion repositories, which lets you submit your changes directly so that anyone else can check them out. 33 34 For more information, check out O'Reilly's free [http://svnbook.red-bean.com/ SVN book online]. 32 If you want to make changes and share them back to the project then you can either push them to a 'fork' on our [http://dev.ibboard.co.uk/repos/ Repository Manager] or create a patch and attach it to a [/query ticket]. Check the [../Contributing Contributing page] for more details. 35 33 36 34 == I'm new to large projects - where do I start? == … … 38 36 It depends where your interest is! WarFoundry isn't an overly large project, but it does come as a number of projects. If you're interested in usability and front-end work then check out the Qt#, GTK# or WinForms interfaces for Linux and Windows respectively. If you want to add back-end functionality then check out the main WarFoundry API project. If you want to help with other file formats then either check out the pre-existing project (e.g. Rollcall or ArmyBuilder) or start your own project from scratch to support another file format. 39 37 40 If you want a specific task to start working on, then there are always [/query bugs and feature requests] for you to investigate. The [tag:papercut 'Papercut'] bugs are generally small bugs that can be picked up and fixed without much in-depth knowledge of WarFoundry. To accept a bug and work on it, sign up for an account , ask IBBoard to make you a "developer", get Subversion access, accept the bug and then commit the fix. Any work on bugs and features would be appreciated, but working on tickets tagged against earlier milestones first is better!38 If you want a specific task to start working on, then there are always [/query bugs and feature requests] for you to investigate. The [tag:papercut 'Papercut'] bugs are generally small bugs that can be picked up and fixed without much in-depth knowledge of WarFoundry. To accept a bug and work on it, sign up for an account here, ask IBBoard to make you a "developer", accept the bug, fix the bug and then [../Contributing contribute the fix]. Any work on bugs and features would be appreciated, but working on tickets tagged against earlier milestones first is best! 41 39 42 40 == How does the ticketing system work and how does it help? == … … 44 42 The ticketing system allows users to record problems and feature requests in an easily recordable and viewable way. It also makes the workflow easier by identifying new tickets, bugs/requests that have been checked and confirmed, tasks that are being worked on, and tasks that are fixed, as well as identifying who is working on or worked on a particular ticket and the changes it required. 45 43 46 Our ticketing system works the same as just about any other Trac system and most bug trackers, with a few [wiki:TracConventions special conventions]. We've also got it hooked up to Subversion, so you can [wiki:Development/CommitConventions#CommitMessages use commit messages] to link commits to tickets and even to close the ticket automatically when you're done.44 Our ticketing system works the same as just about any other Trac system and most bug trackers, with a few [wiki:TracConventions special conventions]. We've also got it hooked up to our version control, so you can [wiki:Development/CommitConventions#CommitMessages use commit messages] to link commits to tickets and even to close the ticket automatically when you're done.