Changes between Version 2 and Version 3 of Development/Contributing


Ignore:
Timestamp:
08/14/11 20:21:14 (8 years ago)
Author:
ibboard
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development/Contributing

    v2 v3  
    33= Contributing =
    44
    5 Coming soon - instructions on how to use the [http://dev.ibboard.co.uk/repos/ Repository Manager] and commit your code.
     5There are three main methods for sharing your contributions so that they can become part of the main WarFoundry program:
    66
    7 == Basic steps ==
     7 1. Create a diff of your changes and share it
     8 1. Create a "fork" on dev.ibboard.co.uk and contribute there
     9 1. Create a "fork" on your own site
    810
    9 1. Create an account on the [http://dev.ibboard.co.uk/repos/ Repository Manager]
    10 1. Go to the project you want to contribute to
    11 1. Hover over "Options" and click "Fork"
    12 1. Give the fork a name and create it
    13 1. Clone the new fork to your development machine
    14 1. Make your changes and commit them locally
    15 1. Push your changes back to your fork
    16 1. Contact IBBoard (or whoever owns the repository you pulled from) to have your changes pulled back into the Master repository
     11== Sharing diffs/patches ==
     12
     13The simplest way to contribute a change is with a patch. Most [wiki:Development/GettingStarted/MercurialClients Mercurial clients] should be able to generate a "diff" file (a file containing the differences between two versions of the same files). The exact method varies between clients.
     14
     15Once a diff has been generated, either attach it to an existing ticket, or create a new ticket and attach it if no ticket exists yet. Other developers can then download the patch and apply it and use it.
     16
     17== Personal forks on dev.ibboard.co.uk ==
     18
     19With the introduction of the [http://dev.ibboard.co.uk/repos/ Repository Manager], it is now easier to make your own work publicly available without having to get commit permissions on the main repository. This keeps experimentation separate and lowers the bar for entry.
     20
     21 1. Create an account on the [http://dev.ibboard.co.uk/repos/ Repository Manager]
     22 1. Go to the project you want to contribute to
     23 1. Hover over "Options" and click "Fork"
     24 1. Give the fork a name and create it
     25 1. Clone the new fork to your development machine
     26 1. Make your changes and commit them locally
     27 1. Push your changes back to your fork
     28 1. Contact IBBoard (or whoever owns the repository you pulled from) to have your changes pulled back into the Master repository
     29
     30== Forks on other sites ==
     31
     32If you already have an account on another site (e.g. [http://bitbucket.org bitbucket]) then you can also make use of that. Instructions may vary slightly depending on the third-party.
     33
     34 1. Find the project(s) you want to contribute to in the [http://dev.ibboard.co.uk/repos/ Repository Manager]
     35 1. Clone the projects to your development machine
     36 1. Make your changes and commit them locally
     37 1. Create a new project (a detached fork) on your third-party host (steps vary)
     38 1. Push your changes back to your third-party host
     39 1. Contact IBBoard (or whoever owns the repository you pulled from) to have your changes pulled back into the Master repository, and make sure that they can get access to it