Latest revision as of 02:03, 14 March 2016

⇐ Table_of_Contents#Developer.27s_Guide{{#if: | | [[{{{2}}}]] }}{{#if: | | [[{{{3}}}]] }}{{#if: | | [[{{{4}}}]] }}{{#if: | | [[{{{5}}}]] }} | ADempiere Version Control{{#if: Create your ADempiere development environment| | Create your ADempiere development environment }} ⇒

Note: As of Release 380, 15 January 2015, the main ADempiere repository has moved to GitHub along with the entire history of the main branches. This document described the process of working with GitHub as well as the instructions for SourceForge. The page will be a work in progress for a few days.

The ADempiere Project Repository

The main repository for ADempiere can be found on the GitHub site at https://github.com/adempiere/adempiere.

Before proceeding, please refer to the Git SCM Documentation.

To collaborate with the ADempiere team, we use the git FORK and PULL model. From the GitHub website:

The fork & pull model lets anyone fork an existing repository and push changes to their personal fork without requiring access be granted to the source repository. The changes must then be pulled into the source repository by the project maintainer. This model reduces the amount of friction for new contributors and is popular with open source projects because it allows people to work independently without upfront coordination.

Refer to the GitHub article on Pull Requests for more information and instructions on how to get started.

Summary Instructions

The setup is easy. Follow these steps:

• Install the Git Software. You can work with the Git command line or any of a number of Git GUI tools. As the repository is on GitHub, it is recommended to follow the GitHub setup procedures.
• Create a GitHub account
• Create your personal fork of the ADempiere project
• Create a local clone of your personal fork
• Follow the instructions in Create your ADempiere development environment, Creating WebUI Workspace using Eclipse Webtool and Create your ADempiere customization environment.
• Start developing!
• Commit your work to your own fork. Follow the ADempiere Software Development Procedure for branch naming.
• Send a pull request to the ADempiere project.

Cloning a Repository

Cloning a repository to your local computer is simple. Follow the instructions with the GitHub software or your GUI tool, many of which allow for cloning a GitHub repository to a local computer with a few mouse clicks. If you want to do it from the command line,

# Navigate to the parent directory where the repository will be placed and type the following command
C:\dev\repos\github>git clone [url]

This will create a directory using the url project name, initialize a .git directory inside it, pull down all the data for that repository, and check out a working copy of the latest version. If you go into the new directory, you’ll see the project files in there, ready to be worked on or used.

To change the name of clone directory use the following

# Navigate to the parent directory where the repository will be placed and type the following command
C:\dev\repos\github>git clone [url] <optional name>

Cloning the Repository with a Slow Connection

To clone a repository over a slow or intermittent Internet connection, try using git fetch instead of clone as follows:

# Create a directory for the repo and change to it
C:\dev\repos\github>mkdir adempiere

C:\dev\repos\github>cd adempiere

# Initialize the repository
C:\dev\repos\github\adempiere>git init
Initialized empty Git repository in C:/dev/repos/github/adempiere/.git/

# The default reference to the source repository in a clone is "origin".  Clone your
# personal fork from your account <account>.
C:\dev\repos\github\adempiere>git remote add origin https://github.com/<account>/adempiere.git

# Fetch the contents.
C:\dev\repos\github\adempiere>git fetch

# Update to the current master branch - for example
C:\dev\repos\github\adempiere>git reset --hard origin/master