development.md

Development Guidelines 💻

1. Make sure you have added yourself as an assignee to the GitHub issue you are working on. In case there is no GitHub issue, please create one or ask the admin to create an issue.
2. Use our installation guidelines to set up the project.

Working in the portal repo

1. Push your local changes to Github.

   • Once you have updated you master branch with the latest changes, you can follow these steps to create a new branch, make changes, and push it to GitHub.

     git checkout -b branchname     # create a branch where you will commit your changes
     git add .                      # stage the changes
     git commit -m 'commit message'        # commit the changes
     git push origin branchname     # push your local branch to GitHub and then create a Pull Request

2. Click here to download sample database Note: For creating migrations and seeders

When you are working in specified module, create migrations/seeders in the specified module instead of the main portal module.

Coding Guidelines and Conventions

1. Naming Conventions

   1. Controllers
   2. Models
   3. Functions/Method
   4. Routes
   5. Variables
   6. Views

2. Database conventions

   1. Table and Fields Naming
   2. Database Alterations

3. Formatting

   1. PSR-2 coding standard

4. Variable Naming Conventions in Employee Portal

   1. Variables Naming Conventions

References

1. Laravel Guidelines
2. Laravel Modules