Development.md

[WIP] This guide is under development

Also see Testing manual.

Overview

Test frameworks we use and their purpose

// Codeception, PHPunit. Structure of tests

Contributing

Before contributing make sure you have last update of your repositories.

(use composer update on whole project or git pull in specific module)

To contribute follow this steps:

1. Fork repository of module you were working on

   to find repository use git remote -v in your module dir and follow link or

   search for this module at hiqdev

2. Type git remote add [remote name] [url] inside your module dir

   [remote name] is name of your remote branch (for example forked)

   [url] is your forked url

3. Type git checkout -b [branch name]

   [branch name] is name of your new brach (for example request)

4. After git add when you make git commit -m [message] follow this simple rules:

   1. Your [message] must start with one word like Added, Changed, Fixed, Removed
   2. Next will follow the description of what exactly was added, changed or removed.

5. Next you git push [remote name] [branch name]

   for example git push forked request

6. After that you need to create a pull request.

   You can do it at github website:

   1. Open repository (for example hipnel)

   2. Click New pull request

      (or click green Compare & pull request and skip iii step)

   3. Click compare across forks and on the right choose your forked repository -> brach name

   4. Click green Create pull request

7. After your pull request was reviewed and you have to make some changes, all you need to do is just make that changes and push to the same [remote name] [branch name].

Make sure that changes you push, for example Added, Removed etc. are all in different pull requests

// Trunk based development

Docker-based development env

// What to read about?

xDebug in Docker

To make xDebug work in PHPStorm you need:

1. Install xDebug

2. Install browser extension

3. In PHPStorm, Add Configuration, choose type PHP Web Page

4. In server settings create server and fill data:

   4.1 Set Name that matches your project domain name set in .env (e.g. local.hipanel.hiqdev.com)

   4.2 localhost in Host

   4.3 80 in Port

   4.4 Xdebug in Debugger

   4.5 Choose Use path mappings option and type /app in Absolute path on the server where File/Directory is root path of your project

5. Turn on Start Listening for PHP Debug Connections and don't forget to activate your debug browser extension

// What to do in PHPStorm, browser, etc?

// How to check that xDebug is enabled on PHP side?

Troubleshooting:

// - debug session does not get started;

// - debug can not locate files;