diff --git a/README.md b/README.md index c5da1134269e5419c2cfa85e45193e9f9b38ec09..382ee78388ef945eb57ed84f681446feab64f8f7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ Vtiger CRM ========== + +Vtiger is a PHP based web application that helps businesses manage their sales and marketing processes. + +Development on vtiger is done at http://code.vtiger.com which is a gitlab server. + +register an account + + +fork vtiger to create your own development area + +file an issue against the vtiger project describing the problem + +create a branch in your fork for a new feature or bug fix + +switch to that branch + +make your changes and commit the fix, reference the issue number in your commit message, +e.g. "fix #2 display projects on the calendar" + +create a merge request from your branch to the upstream master, this will be reviewed to see if it fixes the +issue and if all is good will be merged into the upstream code. + +update your master work area from upstream.