Professional Development Workflow for ERP
Development Environment
This document outlines the development workflow for our project. Following these guidelines ensures efficient collaboration and code integrity.
Project Location:
- Development Path:
c:\anisiis\test.cartzlink.com\httpdocs
Version Control (SVN):
- Individual files or folders can be committed using your CRM user ID and password.
- In case of credential issues, please report the error along with your CRM user ID for troubleshooting.
- Daily commits to the development branch are strongly encouraged.
Deployment Process:
- Code Completion: Once your development is complete and ready for deployment (ready for go live), copy only the necessary code files to the staging environment:
c:\anisiis.staging\test.cartzlink.com\httpdocs
- SVN Commit: Commit the copied code on the staging server using SVN.
- Live Deployment: This committed code will be deployed to the live server.
Best Practices:
- Code Structure: For better maintainability, strive to break down files into smaller logical units instead of massive “fatty” code files.
- Conflict Resolution: It’s a collaborative environment. Multiple developers may be working on the same file.
- In case of conflicts, it’s your responsibility to carefully merge changes, preserving both your and your colleague’s work. Overwriting code will not be tolerated.
- Backup Folder: The
c:\bkp_source_code\2024-07-23folder serves as a backup repository for your previous working copy.- Use this folder to retrieve incomplete or uncommitted code.
- Important Note: This is a read-only backup. Please do not make any new changes in this folder.
CUSTOM FOLDER:
avoid CUSTOM folder as much as possible – only switch to that after approval and try to move the code from custom folder to back to main code – wherever possible
Following these guidelines will ensure a smooth development process and maintain a high-quality codebase.
