laura is hosted by Hepforge, IPPP Durham

Laura++ Developers Information

This is the information page for developers the Laura++ project.

The Laura++ project on Phabricator can be found here.

Checking out the code over ssh

Following the migration to git, it is no longer essential to use the ssh protocol in order to be able to commit changes into the repository, although it is still the recommended method to use. In order to use the ssh protocol, you need to first load your SSH key into your Phabricator profile. Then, to clone the repository you need to do the following:

git clone ssh:// [dirname]

Protection of the master branch and code review

The master branch of the git repository is protected, so in order to push changes to the repository they will need to be pushed to a new branch, where they can be reviewed before merging to the master branch.
Before requesting review it would be helpful to create a task that describes the bug that is being fixed or the new feature that is being implemented and relate your commits to that task (see below). To request review you can click on the commit(s) that you would like to be reviewed, select the Change Auditors action at the bottom of the page and enter the username tlatham. Alternatively, you can include the line
Auditors: tlatham
in the commit message and the audit should be automatically triggered.

Creating/editing tasks for bugs or feature requests

To create a new task, navigate to the Laura++ workboard and decide to which column the new task should belong. In the top right of the column you have chosen, click on the arrow and select Create Task from the menu. Give your task the appropriate title and description. If appropriate, you can assign it to a particular developer and set the priority. The visibility should be set to Public and the task should be Editable by members of the Laura project.

After subsequently committing code changes to address a particular task, you can then edit the task to relate the given commit to the task - click on Edit Related Objects and select Edit Commits, select the commits that you which to associate with the task and then click Save Related Commits.