debian-mirror-gitlab/doc/user/project/issues/issues_functionalities.md

173 lines
6.4 KiB
Markdown
Raw Normal View History

2019-05-30 16:15:17 +05:30
# GitLab Issues Functionalities
2017-08-17 22:00:37 +05:30
Please read through the [GitLab Issue Documentation](index.md) for an overview on GitLab Issues.
2019-05-30 16:15:17 +05:30
## Issues Functionalities
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
The image bellow illustrates how an issue looks like:
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
![Issue view](img/issues_main_view_numbered.jpg)
2017-08-17 22:00:37 +05:30
You can find all the information on that issue on one screen.
### Issue screen
An issue starts with its status (open or closed), followed by its author,
2019-05-30 16:15:17 +05:30
and includes many other functionalities, numbered on the image above to
2017-08-17 22:00:37 +05:30
explain what they mean, one by one.
Many of the elements of the issue screen refresh automatically, such as the title and description, when they are changed by another user.
Comments and system notes also appear automatically in response to various actions and content updates.
#### 1. New Issue, close issue, edit
- New issue: create a new issue in the same project
- Close issue: close this issue
- Edit: edit the same fields available when you create an issue.
#### 2. Todos
2019-05-30 16:15:17 +05:30
- Add todo: add that issue to your [GitLab Todo](../../../workflow/todos.html) list
2018-10-15 14:42:47 +05:30
- Mark todo as done: mark that issue as done (reflects on the Todo list)
2017-08-17 22:00:37 +05:30
#### 3. Assignee
Whenever someone starts to work on an issue, it can be assigned
to that person. The assignee can be changed as much as needed.
The idea is that the assignee is responsible for that issue until
it's reassigned to someone else to take it from there.
> **Tip:**
if a user is not member of that project, it can only be
assigned to them if they created the issue themselves.
2018-05-09 12:01:36 +05:30
##### 3.1. Multiple Assignees **[STARTER]**
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
Often multiple people likely work on the same issue together,
which can especially be difficult to track in large teams
2017-08-17 22:00:37 +05:30
where there is shared ownership of an issue.
2019-05-30 16:15:17 +05:30
In [GitLab Starter](https://about.gitlab.com/pricing/), you can also
select multiple assignees to an issue.
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
Learn more on the [Multiple Assignees documentation](https://docs.gitlab.com/ee/user/project/issues/multiple_assignees_for_issues.html).
2017-08-17 22:00:37 +05:30
#### 4. Milestone
- Select a [milestone](../milestones/index.md) to attribute that issue to.
2017-09-10 17:25:29 +05:30
#### 5. Time Tracking
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
- Estimate time: add an estimate time in which the issue will be implemented
- Spend: add the time spent on the implementation of that issue
2017-08-17 22:00:37 +05:30
> **Note:**
2017-09-10 17:25:29 +05:30
Both estimate and spend times are set via [GitLab Quick Actions](../quick_actions.md).
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
Learn more on the [Time Tracking documentation](../../../workflow/time_tracking.md).
2017-08-17 22:00:37 +05:30
#### 6. Due date
2019-05-30 16:15:17 +05:30
When you work on a tight schedule, and it's important to
have a way to set up a deadline for implementations and for solving
problems. This can be facilitated by the [due date](due_dates.md)). Due dates
2017-08-17 22:00:37 +05:30
can be changed as many times as needed.
#### 7. Labels
Categorize issues by giving them [labels](../labels.md). They help to
2019-05-30 16:15:17 +05:30
organize team's workflows, once they enable you to work with the
[GitLab Issue Board](index.md#gitlab-issue-board).
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
Group Labels, which allow you to use the same labels per
2017-08-17 22:00:37 +05:30
group of projects, can be also given to issues. They work exactly the same,
but they are immediately available to all projects in the group.
> **Tip:**
2019-05-30 16:15:17 +05:30
if the label doesn't exist yet, when you click **Edit**, it opens a dropdown menu from which you can select **Create new label**.
2017-08-17 22:00:37 +05:30
2018-05-09 12:01:36 +05:30
#### 8. Weight **[STARTER]**
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
- Attribute a weight (in a 0 to 9 range) to that issue. Easy to complete
should weight 1 and very hard to complete should weight 9.
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
Learn more on the [Issue Weight documentation](https://docs.gitlab.com/ee/workflow/issue_weight.html).
2017-08-17 22:00:37 +05:30
#### 9. Participants
- People involved in that issue (mentioned in the description or in the [discussion](../../discussions/index.md)).
#### 10. Notifications
- Subscribe: if you are not a participant of the discussion on that issue, but
2019-05-30 16:15:17 +05:30
want to receive notifications on each new input, subscribe to it.
2017-08-17 22:00:37 +05:30
- Unsubscribe: if you are receiving notifications on that issue but no
2019-05-30 16:15:17 +05:30
longer want to receive them, unsubscribe to it.
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
Read more on the [notifications documentation](../../../workflow/notifications.md#issue-merge-request-events).
2017-08-17 22:00:37 +05:30
#### 11. Reference
2019-05-30 16:15:17 +05:30
- A quick "copy to clipboard" button to that issue's reference, `foo/bar#xxx`, where `foo` is the `username` or `groupname`, `bar`
is the `project-name`, and `xxx` is the issue number.
2017-08-17 22:00:37 +05:30
#### 12. Title and description
2019-05-30 16:15:17 +05:30
- Title: a plain text title describing the issue's subject.
- Description: a text field which fully supports [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm).
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
#### 13. @mentions
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
- You can either `@mention` a user or a group present in your
GitLab instance and they will be notified via todos and email, unless that
person has disabled all notifications in their profile settings.
- Mentions for yourself (the current logged in user),will be distinctly highlighted
2018-12-05 23:21:45 +05:30
in a different color, allowing you to easily see which comments involve you,
helping you focus on them quickly.
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
To change your [notification settings](../../../workflow/notifications.md) navigate to
2017-08-17 22:00:37 +05:30
**Profile Settings** > **Notifications** > **Global notification level**
2019-05-30 16:15:17 +05:30
and choose your preferences from the dropdown menu.
2017-08-17 22:00:37 +05:30
> **Tip:**
Avoid mentioning `@all` in issues and merge requests,
as it sends an email notification
to all the members of that project's group, which can be
interpreted as spam.
#### 14. Related Merge Requests
- Any merge requests mentioned in that issue's description
2019-05-30 16:15:17 +05:30
or in the issue thread.
2017-08-17 22:00:37 +05:30
#### 15. Award emoji
- Award an emoji to that issue.
> **Tip:**
2019-05-30 16:15:17 +05:30
Posting "+1" as comments in threads spam all
2017-08-17 22:00:37 +05:30
participants of that issue. Awarding an emoji is a way to let them
know you like it without spamming them.
#### 16. Thread
- Comments: collaborate to that issue by posting comments in its thread.
2019-05-30 16:15:17 +05:30
These text fields also fully support
[GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm).
2017-08-17 22:00:37 +05:30
2018-10-15 14:42:47 +05:30
#### 17. Comment, start a discussion, or comment and close
2017-08-17 22:00:37 +05:30
2019-05-30 16:15:17 +05:30
Once you wrote your comment, you can either:
2017-08-17 22:00:37 +05:30
- Click "Comment" and your comment will be published.
- Click "Start discussion": start a thread within that issue's thread to discuss specific points.
- Click "Comment and close issue": post your comment and close that issue in one click.
2017-09-10 17:25:29 +05:30
#### 18. New Merge Request
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
- Create a new merge request (with a new source branch named after the issue) in one action.
2019-05-30 16:15:17 +05:30
The merge request will automatically inherit the milestone and labels of the issue. The merge
request will automatically close that issue as soon as merged.
2017-09-10 17:25:29 +05:30
- Optionally, you can just create a [new branch](../repository/web_editor.md#create-a-new-branch-from-an-issue)
2019-05-30 16:15:17 +05:30
named after that issue.