Changes between Version 3 and Version 4 of GetInvolved
- Timestamp:
- 07/14/09 20:59:55 (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
GetInvolved
v3 v4 27 27 Instructions on how to get set up with the required tools and source code are in our [wiki:Development/GettingStarted Getting Started] section, but to contribute changes back to the project you need a Subversion account and additional developer permissions on Trac. 28 28 29 To get a developeraccount, sign up on this site and then 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 the account promoted to a "developer" account and a Subversion account created. Once you set up your Subversion repositories with a username and password you will be able to commit to both the WarFoundry and IBBoard utils repositories.29 To get a [wiki:Developer developer] account, sign up on this site and then 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 the account promoted to a "developer" account and a Subversion account created. Once you set up your Subversion repositories with a username and password you will be able to commit to both the WarFoundry and IBBoard utils repositories. 30 30 31 31 == Documenters == 32 32 33 There are t wo main parts of documentation - user and developer. User documentation helps people get started with the tool or use advanced features, while developer documentation helps people understand the API so that they can get to grips with it or write plugins.33 There are three main jobs for a [wiki:Documenter Documenter] - user docs, developer docs and requirements. User documentation helps people get started with the tool or use advanced features, while developer documentation helps people understand the API so that they can get to grips with it or write plugins. Requirement documentation is documentation from a user's point of view that helps developers know what features the users want/need. 34 34 35 Once we approach our first stable release then contributions of user guides could be put together in the [http://forums.hiveworldterra.co.uk/viewforum.php?f=39 forums] before being copied to the main website.35 Once we approach our first stable release then contributions of user guides could be put together in the [http://forums.hiveworldterra.co.uk/viewforum.php?f=39 forums] or this wiki before being copied to the [http://warfoundry.co.uk/ main website]. Members of the "Documenter" group can contribute user directly to the wiki, and anyone is welcome to be a documenter. 36 36 37 37 Most of the developer documentation should be written as the developer's write the API (documenting what public methods do so that they can be tested and so that they have a defined contract of what they will do given certain inputs). A large enough project is always difficult to get started with though, so introductory tutorials adding small features or step-by-step guides to creating plugins may prove useful.