i-MSCP Documentation

i-mscp development is happening on github, the use of git allow the developers to use their own branches for new features, making easier to keep in sync with current development. This is a small guide to help you getting started with git development in i-mscp

• Create an account in http://github.com

• Fork the project i-mscp

The project url is this one, by forking, you only create clone of the project on wich you have commit rights.

• Clone the original github reposotory

You can follow the instructions here

• Change the cloned repositort to use your fork

git remote set-url origin https://[email protected]/your_name/imscp.git

• Create a branch for your great feature

git branch great_feature

• Add the modified files that you want to be commited

git add changed_file1.txt changed_file2.txt 

• Commit your changes (locally)

git commit -m "Commit message"

• Push the changes to your fork (using the created branch name)

git push origin great_feature

• From github interface, ask for a pull request, so it can be integrated on master.

Sometimes is takes a while to merge your changes with upstream, a good way to sync your branch with the upstream is to add a second remote url (the upstream repositorie) and periodically fetch the changes from there:

• Adding the upstream repostory

git remote add upstream https://github.com/i-MSCP/imscp.git

• Fetch any new changes from the original repo

git fetch upstream

• Merge the upstrem code with yours, no more steps if there aren't code conflicts.

git merge upstream/master