From 3bfd228df1b812d6d7b60cc2cdbbc2c064f56556 Mon Sep 17 00:00:00 2001 From: Naoki Takezoe Date: Wed, 23 Dec 2015 23:03:32 +0900 Subject: [PATCH] Update docs --- doc/comment_action.md | 43 +++++++++++++++++++++++++------------------ 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/doc/comment_action.md b/doc/comment_action.md index d5f2d39f1..ac1d0a25c 100644 --- a/doc/comment_action.md +++ b/doc/comment_action.md @@ -5,44 +5,51 @@ The details are saved at ```ISSUE_COMMENT``` table. To determine if it was any operation, you see the ```ACTION``` column. -|ACTION| -|--------| -|comment| -|close_comment| -|reopen_comment| -|close| -|reopen| -|commit| -|merge| -|delete_branch| -|refer| +|ACTION |CONTENT | +|---------------|-----------------| +|comment |comment | +|close_comment |comment | +|reopen_comment |comment | +|close |"Close" | +|reopen |"Reopen" | +|commit |comment commitId | +|merge |comment | +|delete_branch |branchName | +|refer |issueId:title | + +### comment -#####comment This value is saved when users have made a normal comment. -#####close_comment, reopen_comment +### close_comment, reopen_comment + These values are saved when users have reopened or closed the issue with comments. -#####close, reopen +### close, reopen + These values are saved when users have reopened or closed the issue. At the same time, store the fixed value(i.e. "Close" or "Reopen") to the ```CONTENT``` column. Therefore, this comment is not displayed, and not counted as a comment. -#####commit +### commit + This value is saved when users have pushed including the ```#issueId``` to the commit message. At the same time, store it to the ```CONTENT``` column with its commit id. This comment is displayed. But it can not be edited by all users, and also not counted as a comment. -#####merge +### merge + This value is saved when users have merged the pull request. At the same time, store the message to the ```CONTENT``` column. This comment is displayed. But it can not be edited by all users, and also not counted as a comment. -#####delete_branch +### delete_branch + This value is saved when users have deleted the branch. Users can delete branch after merging pull request which is requested from the same repository. At the same time, store it to the ```CONTENT``` column with the deleted branch name. Therefore, this comment is not displayed, and not counted as a comment. -#####refer +##### refer + This value is saved when other issue or issue comment contains reference to the issue like ```#issueId```. At the same time, store id and title of the referrer issue as ```id:title```.