You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/communication-and-collaboration/comments-and-activity.md
+78-60Lines changed: 78 additions & 60 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,40 +5,25 @@ description: Add comments, mention team members, and track activity on work item
5
5
6
6
# Work Item Comments
7
7
8
-
Use comments to discuss work items, ask questions, provide updates, and collaborate with your team. Every work item includes a comment section and activity log.
8
+
Comments are threaded, rich-text messages attached to a work item. They are the primary place for discussion — asking questions, sharing context, reviewing decisions, or signalling blockers — without editing the work item's description or fields.
9
9
10
-
## Add a comment
10
+
Every comment is associated with a specific work item and scoped to a project and workspace. Comments appear in the activity panel of a work item alongside system-generated activity events (field changes, state transitions, assignments), but comments and activity are distinct things: activity is system-written and immutable; comments are user-written and editable.
11
11
12
-
1. Open a work item.
13
-
2. Scroll down to the Activity section.
14
-
3. Click in the **Add comment** field.
15
-
4. Type your comment using the rich text editor.
16
-
5. Click **Comment** to post.
17
-
18
-
19
-
20
-
Your comment appears immediately in the activity feed with a timestamp and your profile picture.
12
+
## Add a comment to a work item
21
13
22
-
## Reply to comments
23
-
24
-
Reply directly to specific comments to keep discussions organized and contextual. Threaded comments help you maintain focused conversations within a work item, especially when multiple topics are being discussed.
29
-
30
-
1. Click the ⋯ menu next to any comment to reveal the actions menu.
31
-
2. Select **Reply**.
32
-
3. Type your response in the reply field.
33
-
4. Click **Comment** to post your reply.
34
-
35
-
Replies appear nested under the original comment, making it easy to follow the conversation thread. Team members get notified when you reply to their comments.
16
+
1. Open a work item.
17
+
2. Navigate to the **Activity** or **Comments** section in the detail panel.
18
+
3. Click the comment input area.
19
+
4. Type your comment. Use **Shift+Enter** to add a line break.
20
+
5. Press **Enter** (or **Mod+Enter** if you have changed your shortcut) to submit, or click the **Comment** button.
36
21
37
-
## Comment features
22
+
Your comment appears immediately in the activity feed with a timestamp and your profile picture.
38
23
39
24
### Rich text formatting
40
25
41
-
The comment editor supports rich text formatting for clear communication:
26
+
The comment editor is a full rich text environment. You can format text (bold, italic, code, lists, headings), embed images, and insert links. Pressing **Shift+Enter** inserts a line break without submitting the comment.
42
27
43
28
**Available formatting:**
44
29
@@ -51,38 +36,68 @@ The comment editor supports rich text formatting for clear communication:
51
36
- Code blocks - Share longer code snippets with syntax
52
37
- Links - Reference external resources
53
38
54
-
### Mention team members
39
+
##Reply to comments
55
40
56
-
Tag team members in comments to notify them and draw their attention to specific work items.
41
+
Comments support one level of threading. Any top-level comment can receive replies. Replies are displayed nested under the parent and show a count of how many replies exist and which members participated. The reply editor behaves identically to the top-level comment editor, including shortcut and mention support.
42
+
43
+
Replies inherit the access level of their parent comment and cannot be changed independently.
44
+
45
+
### Create a threaded reply
46
+
47
+
48
+
49
+
1. Hover over a comment.
50
+
2. Click the **Reply** icon or **Reply** button that appears in the comment toolbar.
51
+
3. Type your reply in the reply input that opens below the comment.
52
+
4. Click **Add reply** to post your reply.
57
53
58
-
**To mention someone**
54
+
Replies appear nested under the original comment, making it easy to follow the conversation thread. Team members get notified when you reply to their comments.
55
+
56
+
## Mention team members
57
+
58
+
Tag team members in comments to notify them and draw their attention to specific work items.
59
59
60
-
1. Type `@` in the comment field.
61
-
2. Start typing the person's name.
62
-
3. Select their name from the dropdown list.
63
-
4. Continue writing your comment.
64
-
5. Post the comment.
60
+
1. While typing a comment, type `@` followed by the name of the member you want to mention.
61
+
2. A suggestion list appears. Use the arrow keys or mouse to select the target.
62
+
3. Press **Enter** or click to insert the mention.
65
63
66
64
**What happens**
67
65
68
66
- The mentioned person receives an email notification (if they have notifications enabled)
69
67
- The work item appears in their Inbox
70
68
71
-
## Manage comments
69
+
## React to a comment
72
70
73
-
### Edit a comment
71
+
1. Hover over the comment.
72
+
2. Click the **emoji** icon in the comment toolbar.
73
+
3. Select an emoji from the picker.
74
+
75
+
Your reaction appears below the comment. Click an existing reaction to add your vote to it or to toggle it off.
76
+
77
+
## Copy a link to a specific comment
78
+
79
+
Share a direct link to a specific comment for reference in other discussions or documents.
80
+
81
+
1. Hover over any comment.
82
+
2. Click the three dots (⋯) menu.
83
+
3. Select **Copy link**.
84
+
85
+
The link copies to your clipboard. When someone clicks the link, they'll be taken directly to that work item with the comment.
86
+
87
+
## Edit a comment
74
88
75
89
Update your comments to fix errors or add additional context.
76
90
77
91
1. Hover over your comment.
78
-
2. Click the three dots (⋯) menu.
79
-
3. Select **Edit**.
80
-
4. Make your changes.
81
-
5. Click **Save** (or press Escape to cancel).
92
+
2. Click the **Edit** (pencil) icon.
93
+
3. Modify the comment text in the editor that opens inline.
94
+
4. Submit to save, or press **Escape** to cancel.
95
+
96
+
Edited comments show an **edited** label with the edit timestamp. The previous version of the comment is preserved in the work item activity log.
82
97
83
98
You can only edit your own comments.
84
99
85
-
###Delete a comment
100
+
## Delete a comment
86
101
87
102
Remove comments that are no longer relevant or were posted in error.
88
103
@@ -91,23 +106,13 @@ Remove comments that are no longer relevant or were posted in error.
91
106
3. Select **Delete**.
92
107
4. Confirm the deletion.
93
108
94
-
You can only delete your own comments.
109
+
You can only delete your own comments. Admins can delete other members' comments.
95
110
96
111
::: warning
97
-
Deleted comments cannot be recovered.
112
+
Deletion is permanent. The deletion event is recorded in the work item activity log.
98
113
:::
99
114
100
-
### Copy comment link
101
-
102
-
Share a direct link to a specific comment for reference in other discussions or documents.
103
-
104
-
1. Hover over any comment.
105
-
2. Click the three dots (⋯) menu.
106
-
3. Select **Copy link**.
107
-
108
-
The link copies to your clipboard. When someone clicks the link, they'll be taken directly to that work item with the comment.
109
-
110
-
## Activity log
115
+
## Activity tracking
111
116
112
117
The Activity log shows a chronological history of everything that happens on a work item, including comments and system updates.
113
118
@@ -132,16 +137,16 @@ The Activity log shows a chronological history of everything that happens on a w
132
137
- Attachments uploaded
133
138
- Description edits
134
139
140
+
Every comment action — creation, edit, or deletion — is recorded as a work item activity event. This means the full comment history (including the text of previous versions on edit) is preserved in the activity log. Reaction events are also logged.
141
+
142
+
Comment edits display an **edited** indicator with the `edited_at` timestamp. The original text is accessible in the activity log.
143
+
135
144
### Filter activity
136
145
137
146
Show only specific types of activity to focus on what matters.
138
147
139
148
1. Click the **Filters** button in the Activity panel.
140
-
2. Select activity types to display:
141
-
-**All** - Show everything
142
-
-**Comments** - Only comments
143
-
-**Activity** - Only system updates (status changes, assignments, etc.)
144
-
-**Worklogs** - Only time tracking entries
149
+
2. Select **Assignee** to see relevant activity.
145
150
3. The activity log updates immediately.
146
151
147
152
### Sort activity
@@ -155,4 +160,17 @@ Change the order in which activities appear.
155
160
156
161
Click the sort icon next to Filters to toggle between sort orders.
157
162
158
-
---
163
+
## Notification preferences
164
+
165
+
Members can configure whether they receive email notifications for new comments on work items they are involved in. This is set per-workspace and can be further overridden at the project level. The preferences cover two triggers:
166
+
167
+
-**Comment** — a new comment is posted on a work item you are subscribed to, assigned to, or created
168
+
-**Mention** — you are @mentioned in a comment
169
+
170
+
## Comment submit shortcut
171
+
172
+
By default, pressing **Enter** submits a comment. Pressing **Shift+Enter** always inserts a line break regardless of this setting.
173
+
174
+
If you prefer to use Enter freely for line breaks and only submit intentionally, you can switch the shortcut to **Mod+Enter** (Ctrl+Enter on Windows/Linux, ⌘+Enter on macOS) in your profile preferences. This setting is stored on your user profile and applies globally — it affects the comment create form, the comment edit form, and the reply editor, across all projects and workspaces.
175
+
176
+
The setting is per-user, not per-workspace. Other members are not affected by your preference.
A work item in Project A can be a sub-work item of a work item in Project B. The parent picker searches across the entire workspace.
101
+
99
102
## Duplicate work items <Badgetype="info"text="Pro" />
100
103
101
104
When you need to create similar work items or replicate a work item's structure and properties, Plane lets you duplicate existing work items either within the same project or across different projects.
@@ -151,7 +154,7 @@ Plane allows you to upload different file types directly to the work item. Use t
151
154
JPEG, PNG, GIF, SVG, WebP, TIFF, BMP
152
155
153
156
-**Documents**
154
-
PDF, Microsoft Word, Microsoft Excel, Microsoft PowerPoint, Plain Text, Rich Text Format (RTF), OpenDocument Spreadsheet, OpenDocument Text, OpenDocument Presentation, OpenDocument Graphics
157
+
PDF, Microsoft Word, Microsoft Excel, Microsoft PowerPoint, Plain Text, Rich Text Format (RTF), Markdown, OpenDocument Spreadsheet, OpenDocument Text, OpenDocument Presentation, OpenDocument Graphics
Pages lets you export your content in various formats, including PDF and Markdown. This feature is a game-changer for project managers and team members who need to share information with stakeholders, clients, or team members who might not be using Plane.
180
+
Pages lets you export your content in various formats, including PDF, Word, and Markdown. This feature is a game-changer for project managers and team members who need to share information with stakeholders, clients, or team members who might not be using Plane.
181
181
182
182
When you export to PDF, your documents keep their formatting, making them easy to share and print without any hassle. If you choose to export to Markdown, you can seamlessly integrate your content into other tools or platforms, streamlining your workflow.
0 commit comments