GITHUB and proper procedures - Revision history

LegacyKing at 02:59, 25 January 2015

2015-01-25T02:59:27Z

Elro the onk: /* Windows */

2015-01-08T13:15:45Z

‎Windows

Elro the onk: /* Windows */

2015-01-08T13:13:55Z

‎Windows

Elro the onk: Added link to NewSource howto help page on GitHub

2015-01-08T12:44:41Z

Added link to NewSource howto help page on GitHub

Elro the onk: Adding link to fork syncing help page on GitHub

2015-01-08T12:42:20Z

Adding link to fork syncing help page on GitHub

LegacyKing: /* PCGen Projects */

2015-01-05T21:26:55Z

‎PCGen Projects

Zaister: /* Linux */

2014-12-13T20:30:24Z

‎Linux

LegacyKing: Update language to reflect multiple projects.

2014-12-13T02:09:46Z

Update language to reflect multiple projects.

LegacyKing: Initial notes

2014-12-06T00:43:00Z

Initial notes

New page

GITHUB is a wonderful collaboration tool for developers. We at PCGen are migrating from the SVN repository we host of SF to the free hosting at GITHUB. Most people should be familiar with GIT and GITHUB, but we'll go over what our procedures are:

If you plan on being a developer and contributing follow these steps:

* 1) Sign in to github with your account. (You should have a SSH key)
* 2) Navigate to our pcgen [LINK PENDING] repository and click the FORK button
* 3) Navigate to your FORK of the pcgen project and use the SHH link for cloning a local copy
* 4) Choose a local folder to house your local copy and clone the copy there.
* 5) Add a remote repository and link it to the main pcgen (or upstream) -- OPTIONAL STEP
* 6) Once your local copy is downloaded, do a git checkout and name your branch* See Branch Naming below
* 7) Once you're down working on your feature/bug branch, add/commit/push those changes to your remote repository
* 8) Do a PR (Pull Request) from your repository to the main pcgen repository, using the branch you pushed in - make an explanation summary or JIRA ID

If you want to maintain an up-to-date copy of the pcgen repository, but do not have plans to contribute in the near future, you may easily do the following:
* 1) Navigate to our pcgen [LINK PENDING] repository
* 2) Click the SHH link for cloning a local copy
* 3) Choose a local folder to house your local copy and clone the copy there.

This will allow you to grab updates from pcgen, but not push any changes.

Feature/Bug Branch Naming Practices:
* All Features or Bugs should have a corresponding JIRA ID, example: CODE-1234, or DATA-4321. Your Branch should be JIRA-ID_Title, example: DATA-1234_Fix_Bard_Skills

SSH Keys are useful and should be used whenever possible. For Windows, PuttyGen will allow you to create your own SSH Key.

'''TOOLS:'''
* Command line for GIT is by far the superior method. However, we have found tools that our developers like to use and recommend them as easier alternatives to the command line if you choose to do so.

Windows -
* Atlassian's free SourceTree GUI program
* TortoiseGIT (Shell integration)

Mac -
*

Linux -
* RabbitVCS (Shell integration)

← Older revision		Revision as of 02:59, 25 January 2015
Line 59:		Line 59:
	====Linux====		====Linux====
	* RabbitVCS (Gnome only, integrates with Nautilus)		* RabbitVCS (Gnome only, integrates with Nautilus)
		+
		+
		+	==Branches and keeping in sync tips:==
		+
		+	* In GITHUB you can do this by:
		+	* git checkout master
		+	* git fetch –f upstream
		+	* git rebase –f upstream/master
		+	* git push –f origin
		+
		+	That will make your master branch a mirror of the upstream master branch. Then if you kept your working branch and expect to continue work in that branch rather than creating a new branch, you would:
		+
		+	* git checkout mybranch
		+	* git rebase –f master
		+	* git push –f origin

@@ Line 51: / Line 51: @@
 ====Windows====
-* Atlassian's free SourceTree GUI program ([[Helpful Tips]])
+* Atlassian's free SourceTree GUI program ([[SourceTree Helpful Tips]])
 * TortoiseGIT (Shell integration)

@@ Line 51: / Line 51: @@
 ====Windows====
-* Atlassian's free SourceTree GUI program
+* Atlassian's free SourceTree GUI program ([[Helpful Tips]])
 * TortoiseGIT (Shell integration)

← Older revision		Revision as of 12:44, 8 January 2015
Line 38:		Line 38:
	* Ideally, you should squash your commits into one commit before pushing into your remote.		* Ideally, you should squash your commits into one commit before pushing into your remote.

		+	There is a useful aide-memoire on GitHub, https://github.com/PCGen/pcgen-newsources/wiki/Contributing-to-NewSources.

	===PCGen Projects===		===PCGen Projects===

@@ Line 11: / Line 11: @@
 * 3) Navigate to your FORK of the pcgen project and use the SHH link for cloning a local copy
 * 4) Choose a local folder to house your local copy and clone the copy there.
-* 5) Add a remote repository and link it to the main pcgen project (or upstream) -- OPTIONAL STEP: This allows fast update to your local copy from the main project.
+* 5) Add a remote repository and link it to the main pcgen project (or upstream) -- OPTIONAL STEP: This allows fast update to your local copy from the main project, see https://help.github.com/articles/syncing-a-fork/.
 * 6) Once your local copy is downloaded, do a git checkout and name your branch* (See Branch Naming practices below)
 * 7) Once you have finished working on your feature/bug branch, do the git equivalent of 'add', 'commit', and then 'push' those changes to your remote repository. (See GIT Commit Summary Practices)

@@ Line 42: / Line 42: @@
 All Active PCGen Repositories are held under the Username "PCGen" which is our organization on github.com. You can find the repositories we host here: https://github.com/PCGen
-* Our Main Development Program is "PCGen" (Planned active as of December 22nd, 2014)
+* Our Main Development Program is "PCGen"  -  git@github.com:PCGen/pcgen.git
-* Our New Source Development is NewSources (Active Now)
+* Our New Source Development is NewSources (Active Now)  -  git@github.com:PCGen/pcgen-newsources.git
 ===GIT TOOLS===

← Older revision		Revision as of 20:30, 13 December 2014
Line 58:		Line 58:

	====Linux====		====Linux====
−	* RabbitVCS (~~Shell integration~~)	+	* RabbitVCS (Gnome only, integrates with Nautilus)

@@ Line 1: / Line 1: @@
 GITHUB is a wonderful collaboration tool for developers. We at PCGen are migrating from the SVN repository we host of SF to the free hosting at GITHUB. Most people should be familiar with GIT and GITHUB, but we'll go over what our procedures are:
 If you plan on being a developer and contributing follow these steps:
 * 1) Sign in to github with your account. (You should have a SSH key)
-* 2) Navigate to our pcgen [LINK PENDING] repository and click the FORK button
+* 2) Navigate to the pcgen project you wish to contribute too and click the FORK button. (See below for link)
 * 3) Navigate to your FORK of the pcgen project and use the SHH link for cloning a local copy
 * 4) Choose a local folder to house your local copy and clone the copy there.
-* 5) Add a remote repository and link it to the main pcgen (or upstream) -- OPTIONAL STEP
+* 5) Add a remote repository and link it to the main pcgen project (or upstream) -- OPTIONAL STEP: This allows fast update to your local copy from the main project.
-* 6) Once your local copy is downloaded, do a git checkout and name your branch* See Branch Naming below
+* 6) Once your local copy is downloaded, do a git checkout and name your branch* (See Branch Naming practices below)
-* 7) Once you're down working on your feature/bug branch, add/commit/push those changes to your remote repository
+* 7) Once you have finished working on your feature/bug branch, do the git equivalent of 'add', 'commit', and then 'push' those changes to your remote repository. (See GIT Commit Summary Practices)
 * 8) Do a PR (Pull Request) from your repository to the main pcgen repository, using the branch you pushed in - make an explanation summary or JIRA ID
-If you want to maintain an up-to-date copy of the pcgen repository, but do not have plans to contribute in the near future, you may easily do the following:
+===Just want a Copy of a project===
-* 1) Navigate to our pcgen [LINK PENDING] repository
+If you want to maintain an up-to-date copy of the pcgen project repository, but do not have plans to contribute in the near future, you may easily do the following:
-* 2) Click the SHH link for cloning a local copy
+* 1) Navigate to the pcgen project repository (See below for link)
 * 3) Choose a local folder to house your local copy and clone the copy there.
-This will allow you to grab updates from pcgen, but not push any changes.
+Of course, you are always able to use the download, to get a snapshot of the project. This is the least recommended method of having access to the project.
-Feature/Bug Branch Naming Practices:
+===Feature/Bug Branch Naming Practices:===
 * All Features or Bugs should have a corresponding JIRA ID, example: CODE-1234, or DATA-4321. Your Branch should be JIRA-ID_Title, example: DATA-1234_Fix_Bard_Skills
@@ Line 25: / Line 31: @@
-'''TOOLS:'''
+===Git Commit Summary Practices===
 * Command line for GIT is by far the superior method. However, we have found tools that our developers like to use and recommend them as easier alternatives to the command line if you choose to do so.
-Windows -
+====Windows====
 * Atlassian's free SourceTree GUI program
 * TortoiseGIT (Shell integration)
-Mac -
+====Mac====
+* ...Pending...
-Linux -
+====Linux====
 * RabbitVCS (Shell integration)