Documentation

From pCT
Revision as of 09:15, 9 December 2016 by Mri083 (talk | contribs) (Renaming the pages for the installation of the individual programs)

Main Page -> Documentation

Mailing lists and collaborative tools

  • Project web page: has to come
  • General mailing list: pCT@uib.no
  • Slack project

Software installation

Software repository

We will use the gitlab server hosted by IT of University of Bergen, the link will appear here as soon as they provide the service.

Development workflow

Note: the repository has not yet been created

Everyone can access the main repository, however only a small group of administrators has write access. However, every user can fork a repository, this creates a copy where a single developer or a group of developers have full access.

The main repository has the following branches:

  • production: the latest production code, in this branch we have release tags
  • master: the latest stable release
  • dev: the development branch

In addition to those main branches there can be feature branches where development happens detached from the main branches. A feature branch is based on the dev branch.

Creating a project fork

How to fork a project

Making local development copy

   git clone <project link>

Pushing to development fork

Pull/Merge request

All updates to the main repository are made via merge requests (github refers to them as pull requests). A merge request requires the code update to be in a mergable branch in a development fork.

Coming soon: HOWTO

User documentation