Contributing Index

If you would like to help with making HMS, then you are more than welcome to.

You will need to have Vagrant and VirtualBox installed on your computer. Visit their websites below for help with this.

• Vagrant
• VirtualBox

You will also need to make an entry in your computer's hosts file. Add the following line:

192.168.25.35 hmsdev

The hosts file is located in one of these locations:

• Windows: C:\Windows\System32\Drivers\etc\hosts
• Mac: /private/etc/hosts
• Linux: /etc/hosts

Once you have these installed, you can clone the repository onto your computer and run vagrant up at the terminal. This will start a virtual machine (VM) with all the software required to run the project.

Pull Requests

All changes must be made through pull requests

If you have write access to this repository (you are member of the Nottingham Hackspace Software Team) then you can create a branch within the repository itself and start a pull request from that branch.

If you don't have write access to this repository, you can fork it into your own profile and start a pull request from there.

All pull requests need an approving review before they can be merged.

Debuging

The Vagrant environment includes xdebug

Xdebug documentation can be found at https://xdebug.org/docs/

Useful Laracast videos https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/19 https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/20

###PHPStorm PHPStorm has built in support Setup via Debug "Edit configurations" -> "Add New Configuration" -> "PHP Web Application". Absolute path on set should be "/vagrant"

###SublimeText Use the "Xdebug client" via package control and this guide https://www.sitepoint.com/debugging-xdebug-sublime-text-3/ Use the following in your sublime project settings, replacing with correct path to your working copy

"settings": {
    "xdebug": {
         "url": "http://hmsdev/",
         "path_mapping": {
            "/vagrant/" : "/YOUR/PATH/TO/PROJECT/hms2/"
        }
    }
}