Developer Workflow and Guidelines

Daily Workflow

  1. End of Day Commit: Push your developments to your assigned branch and inform the senior developer or the developer in charge by 5:30 PM every day.
  2. Overtime Work: If you work overtime, push your changes either at the start of the next day or immediately after finishing your work, then inform the senior developer or the developer in charge.
  3. Code Quality: Maintain a clean code flow with appropriate use of spaces and line breaks. Ensure that your code is readable and maintainable.
                                
        <table class="table">
            <thead>
                <tr>
                    <th>Header 1</th>
                    <th>Header 2</th>
                </tr>
            </thead>
            <tbody>
                <tr>
                    <td>Data 1</td>
                    <td>Data 2</td>
                </tr>
            </tbody>
        </table>
                                
                            
  4. Use of Comments: Always use necessary comments for main developments. In the comments, describe below points:
    • The code description. (What the code does) Do not describe too much
    • If a modification happens (Due to the customer's or tech teams' request), you must mention which customer requested, which tech member involved in it and the date of the modification.
    • If you ever encountered a previously modified code to be modified again (If there is a comment) mention it to the tech member that it has been edited before by this customer.
      ** This type of modifications are not allowed unless it's been approved by the tech team leader. Please double verify about these changes. **
  5. Variable Naming: Use meaningful variable names.
    • For models and controllers, use PascalCase.
    • For frontend operations, use snake_case.
    • For other PHP variables, you can use either camelCase or snake_case.



Design and Style Guidelines

Form Input Guidelines

Use the default form-control class for standard inputs. Use the col-md-4 OR col-md-3 to separate the fields. Label must be on top of the input field. Text field width must be same as the normal field

                    
                        <input type="text" class="form-control" placeholder="Default input">
                        
                    

Preview:



Font Sizes

Utilize Bootstrap utility classes for managing font sizes.



Colors

Ensure cohesive design by following these color guidelines:



Button Styles

Buttons should follow these guidelines for color consistency:



Navigation Bar



Tables

Use DataTables with pagination and search options for history sections.
Use Bootstrap tables and apply the following classes to all tables.
For currency, text must be aligned right side.


    <table class="table table-hover table-responsive">
        <thead>
            <tr>
                <th>Header</th>
                <th>Header 2</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>Data 1</td>
                <td>Data 2</td>
            </tr>
        </tbody>
    </table>
                

Preview:

Header Header 2 Currency
Data 1 Data 2 1000.00
Data 1 Data 2 750.00
Data 1 Data 2 99.90

Avoid using tables inside tables. Use div tags for nested data structures.

For history tables with pagination and search options, use DataTables:


    <table id="example" class="table table-hover table-bordered table-responsive">
        <thead>
            <tr>
                <th>Name</th>
                <th>Position</th>
                <th>Office</th>
                <th>Age</th>
                <th>Start date</th>
                <th>Salary</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>Tiger Nixon</td>
                <td>System Architect</td>
                <td>Edinburgh</td>
                <td>61</td>
                <td>2011/04/25</td>
                <td>$320,800</td>
            </tr>
            <!-- More rows as needed -->
        </tbody>
    </table>
                

Preview:

Name Position Office Age Start date Salary
Tiger Nixon System Architect Edinburgh 61 2011/04/25 $320,800
Nixon Tiger System Architect New York 61 2010/04/25 $350,000


Charts

Use React-based charts with 3D support where appropriate. Get approval from a senior developer before using 3D charts in any section.