Changes between Version 4 and Version 5 of CodeManagementReleaseProcess

Timestamp:

11/25/11 18:10:37 (5 years ago)

Author:

jim

Comment:

more edits for Git

CodeManagementReleaseProcess

@@ -26 +26 @@
 == Software & Getting Started ==
 You obviously must have Git installed on your machine to work on this project. The basic Git command line software available for most platforms in from http://git-scm.com/ - however, some very nice applications are also available that integrate into your operating system's graphical interface. Recommended '''FREE''' Git applications with a nice GUI are:
- * Linux: RabbitVCS - http://wiki.rabbitvcs.org/wiki/download
+ * Linux: RabbitVCS - http://wiki.rabbitvcs.org/wiki/download -- use the PPA if on Debian-compatible distro
  * Windows: Lots available...
  * Mac: Not sure, all seems commercial - anyone know better?
@@ -32 +32 @@
 To get started, you need a copy of the code and ideally a web server (Apache), database (MySQL) and Drupal set up on your machine. We assume as a web developer you already have this, but Google and http://drupal.org/start are certainly your friends if not. Once you're set up, please run this command to get a copy of the current development (DEV) code.
 
-You will also need an SSH account set up on the DEV server so that you are able to log in and get code, or push it back again.
+NOTE: You will also need an SSH account set AND to have your SSH keys added to the GitHub repository before you will have access to the repositories.
 {{{
 cd /the/directory/you/want/the/project/folder/in
-git clone USER@dev.transitionnetwork.org:/web/tech.transitionnetwork.org/git/www/
+git clone -b [branch] git@github.com:i-jk/Transition-Network.git dev
 }}}
-Where 'USER' is the account name of your SSH account on DEV. You'll be asked for your account password on DEV before Git copies the repository onto your machine. Also, the 'www' at the end of the second command can be exchanged for the other project folders, e.g. 'sharing-engine'.
+Where [branch] is the branch you want to work with... Branches available on GitHub are: {{{development}}}, {{{live}}}. Use {{{development}}} for all normal work as this branch is available on the DEV server. Use {{{live}}} only for making small, incremental updates based on the code in LIVE -- but avoid this approach unless absolutely necessary.
 
 Once you have this, you will be able to edit files on your machine and then later commit them back to the repository - once TESTED of course! '''Note''' that the above checkout DOES NOT contain the Drupal settings.php files, nor any files uploaded to the server. It will contain the site's theme though: you will need to get or create these as needed for your setup and configuration.
+
 
 == Release Process Detail ==
@@ -45 +46 @@
 
 The process is as follows:
+
+
+=== 0. GET THE LATEST UPDATES! ===
+You MUST start by getting all the changes in the the origin GitHub repository...
+ * If you've not already cloned the branch you want to work with, follow the instructions above in 'Getting Started'
+ * If you have, you'll need to pull the latest changes:
+{{{
+
+}}}
+
+=== Creating/Working with your own branches ===
+If you're working on something and need to keep these changes from the rest of the development, always make your own branch on your local machine. Read the Git documentation for this, but the process is roughly as follows:
+{{{
+git branch [newbranch]
+git checkout [newbranch]
+... do your stuff ...
+
 === 1. Edit you code, test locally ===
 As you modify the source code and theme files on your checked out working copy, the differences between your copy and the Trunk will grow. It's wise therefore to do smaller chunks of work and commit once these specific bits are completed. Clearly, if several developers are working on the same areas at once, you will have to coordinate your work and be more careful.