Skip to content

Commit

Permalink
docs: polish the issues.type description (#779)
Browse files Browse the repository at this point in the history 
Co-authored-by: Startrekzky <[email protected]>
  • Loading branch information
@Startrekzky @merico-devlake
Startrekzky and merico-devlake authored Aug 22, 2024
1 parent 53ddd2b commit 983c87e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/DataModels/DevLakeDomainLayerSchema.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,14 @@ An `issue` is the abstraction of GitHub/GitLab/BitBucket/Jira/TAPD/Zentao... iss

| **field** | **type** | **length** | **description** | **key** |
|:----------------------------|:----------------------------------------------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
| `id` | varchar | 255 | An issue's `id` is composed of < plugin >:< Entity >:< PK0 >[:PK1]..." <ul><li>For Github issues, a Github issue's id is like "github:GithubIssues:< GithubIssueId >". E.g. 'github:GithubIssues:1049355647'</li> <li>For Jira issues, a Github repo's id is like "jira:JiraIssues:< JiraSourceId >:< JiraIssueId >". E.g. 'jira:JiraIssues:1:10063'. < JiraSourceId > is used to identify which jira source the issue came from, since DevLake users can import data from several different Jira instances at the same time.</li></ul> | PK |
| `id` | varchar | 255 | An issue's `id` is composed of < plugin >:< Entity >:< PK0 >[:PK1]..." <ul><li>For Github issues, a Github issue's id is like "github:GithubIssues:< GithubIssueId >". E.g. 'github:GithubIssues:1049355647'</li> <li>For Jira issues, a Github repo's id is like "jira:JiraIssues:< JiraSourceId >:< JiraIssueId >". E.g. 'jira:JiraIssues:1:10063'. < JiraSourceId > is used to identify which Jira source the issue came from, since DevLake users can import data from several different Jira instances at the same time.</li></ul> | PK |
| `issue_key` | varchar | 255 | The key of this issue. For example, the key of this Github [issue](https://github.com/apache/incubator-devlake/issues/1145) is 1145. | |
| `url` | varchar | 255 | The url of the issue. It's a web address in most cases. | |
| `title` | varchar | 255 | The title of an issue | |
| `description` | longtext | | The detailed description/summary of an issue | |
| `type` | varchar | 100 | The standard type of this issue. There are 3 standard types: <ul><li>REQUIREMENT: this issue is a feature</li><li>BUG: this issue is a bug found during test</li><li>INCIDENT: this issue is a bug found after release</li></ul>The 3 standard types are transformed from the original types of an issue. The transformation rule is set in the '.env' file or 'config-ui' before data collection. For issues with an original type that has not mapped to a standard type, the value of `type` will be the issue's original type. | |
| `type` | varchar | 100 | The standard type of this issue. There are 3 standard types: <ul><li>REQUIREMENT: this issue is a feature</li><li>BUG: this issue is a bug found during test</li><li>INCIDENT: this issue is a bug found after release</li></ul>The 3 standard types are transformed from the original type of an issue. The transformation rule is set in the Scope Config on the Connections page of Jira, GitHub and etc. <br/>For issues with an original type that has not mapped to a standard type, the value of `type` will be the same as issue's `original_type`. | |
| `original_type` | varchar | 100 | The original type of an issue. | |
| `status` | varchar | 100 | The standard statuses of this issue. There are 3 standard statuses: <ul><li> TODO: this issue is in backlog or to-do list</li><li>IN_PROGRESS: this issue is in progress</li><li>DONE: this issue is resolved or closed</li></ul>The 3 standard statuses are transformed from the original statuses of an issue. The transformation rule: <ul><li>For Jira issue status: transformed from the Jira issue's `statusCategory`. Jira issue has 3 default status categories: 'To Do', 'In Progress', 'Done'.</li><li>For Github issue status: <ul><li>open -> TODO</li><li>closed -> DONE</li></ul></li></ul> | |
| `status` | varchar | 100 | The standard statuses of this issue. There are 3 standard statuses: <ul><li> TODO: this issue is in backlog or to-do list</li><li>IN_PROGRESS: this issue is in progress</li><li>DONE: this issue is resolved or closed</li></ul>The 3 standard statuses are transformed from the original statuses of an issue. The transformation rule: <ul><li>For Jira issue status: transformed from the Jira issue's `statusCategory`. Jira has 3 default issue status categories: 'To Do', 'In Progress', 'Done'.</li><li>For Github issue status: <ul><li>open -> TODO</li><li>closed -> DONE</li></ul></li></ul> | |
| `original_status` | varchar | 100 | The original status of an issue. | |
| `story_point` | double | | The story point of this issue. Only certain types(e.g. story) of Jira or TAPD issues has story points | |
| `priority` | varchar | 255 | The priority of the issue | |
Expand Down

0 comments on commit 983c87e

Please sign in to comment.