Developer Documentation

Jump to bottom

LIU Lin edited this page Jun 16, 2020 · 15 revisions

Prerequisites

Visual Studio
MongoDB
.NET Framework

The project is built upon the 3-tier software design architecture:

Presentation layer, see directory 'GUI'
Business Logic layer, see directory 'BLLayer'
Data Access layer, see directory 'Database'
Entities, see directory 'ValueObject'

Besides, directory 'UnitTests' is for saving unit test code and test data files.

Workflow

Reference: https://www.atlassian.com/git/tutorials/comparing-workflows

Get the most updated code

$ git clone [email protected]:SZ559/Well-Trajectory-Visualization-GUI-.git

Create your branch for development (ex: new "dev" branch)

$ cd Well-Trajectory-Visualization-GUI-
$ git checkout -b dev

Add new features, fix bugs, or do whatever you want in your branch, and commit

$ git add .
$ git commit -m "your commit message"

Before pushing your updates to remote, pull the most updated "master" branch and merge to your "dev" branch. Resolve the conflicts if possible.

$ git pull --rebase origin master

## resolve conflicts... and continue
$ git add <changed-files>
$ git rebase --continue

$ git push -u origin dev

Open a new pull request to ask for merging your updates to "master" branch. Remember that if the pull request is merged, your remote "dev" branch will also be deleted.
When updates are merged, change local branch to "master", pull new updates and checkout new development branch from the updated "master" branch.

git checkout master
git pull
git branch -d dev
git checkout -b dev

Repeat steps 3-6.

Rules to follow:

pull the most updated code regularly/daily - step 4

Technical Details