Difference between revisions of "StoryBoard/ObjectModel"
(→Entities Details) |
(→Entities List) |
||
Line 1: | Line 1: | ||
<big>Storyboard Object Model</big> | <big>Storyboard Object Model</big> | ||
− | == | + | == Project Models == |
* Project Group | * Project Group | ||
* Project | * Project | ||
* Branch | * Branch | ||
* Milestone | * Milestone | ||
+ | |||
+ | == Story Models == | ||
* Story | * Story | ||
* Story Tag | * Story Tag | ||
* Task | * Task | ||
* Comment | * Comment | ||
+ | |||
+ | == User Model == | ||
+ | * User(TBD replace Django User) | ||
+ | * Role(TBD) | ||
+ | * Permission(TBD) | ||
+ | * Subscription(TBD) | ||
== Entities Details == | == Entities Details == |
Revision as of 13:52, 22 November 2013
Storyboard Object Model
Contents
Project Models
- Project Group
- Project
- Branch
- Milestone
Story Models
- Story
- Story Tag
- Task
- Comment
User Model
- User(TBD replace Django User)
- Role(TBD)
- Permission(TBD)
- Subscription(TBD)
Entities Details
Project Group
A Project Group object represents a list of projects which are closely dependent on each other.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
name | string | Project Group short name. One word names are preferred. |
title | string | A detailed description for the entire Project Group. |
members | list(Project) | A list of Projects that belong to this Project Group. |
Project
A Project object represents a single project.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
name | string | A Project short name. One word names are preferred. |
title | string | A detailed description for the Project. |
Branch
A Branch object represents a single development branch.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
name | string | Full Branch name. |
short_name | string | Short Branch name. |
status | char | Release status of a Branch. This may be M - master, R - release, S - stable, U - unsupported. |
Milestone
A Milestone object is used for associating Stories with a moment of time, when they are expected to be implemented.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
name | string | Milestone name. |
branch | Branch | A Branch to which this Milestone belongs to. |
released | boolean | Is this Milestone already released. |
undefined | boolean | Milestone marked 'undefined' is similar to 'next' Milestone in Launchpad. |
Story
A Story is a basic object to describe bugs and features Stories are used to group Tasks.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
title | string | Story name. |
description | string | Full Story description. |
is_bug | boolean | Is this Story a bug or a feature. |
priority | integer | 0 - Undefined, 1 - Low, 2 - Medium, 3 - High, 4 - Critical. |
creator | User | User who has created this Story. |
Story Tag
A Tag object is used to mark Stories for future search and ordering.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
name | string | Tag name. |
story | Story | The Story, to which this Tag belongs to. |
Task
A Task is a Project specific part of a Story (Feature or Bug).
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
title | string | Task name. |
story | Story | The Story, to which this Task belongs to. |
project | Project | The Project, to which this Task belongs to. |
assignee | User | The User assigned to this Task. May be empty. Empty by default. |
status | char | T - Todo, R - In review, L - Landed. |
milestone | Milestone | The Milestone when this Task is expected to be implemented. |
Comment
A Comment for a Story. Comments are created automatically on events like adding a Task, changing Priority, etc. A user may also post a Comment.
Field Name | Type | Description |
---|---|---|
id | integer | A primary key for a database. |
story | Story | The Story, to which this Comment belongs to. |
posted_date | Date | The date and time when this Comment has been posted. |
author | User | The User who has posted the comment or made a change in the Story. |
action | string | The action which produced this Comment. |
comment_type | string | This field is used for formatting purposes, like setting an Icon for a comment. |
content | text | The actual content of the Comment. |