time_tracking.md 2.8 KB
Newer Older
1 2 3 4
# Time Tracking

> Introduced in GitLab 8.14.

5 6
Time Tracking allows you to track estimates and time spent on issues and merge
requests within GitLab.
7 8 9 10

## Overview

Time Tracking lets you:
11 12 13

- Record the time spent working on an issue or a merge request.
- Add an estimate of the amount of time needed to complete an issue or a merge
14
  request.
15 16 17 18 19 20 21 22 23 24

You don't have to indicate an estimate to enter the time spent, and vice versa.

Data about time tracking is shown on the issue/merge request sidebar, as shown
below.

![Time tracking in the sidebar](time-tracking/time-tracking-sidebar.png)

## How to enter data

Marcia Ramos's avatar
Marcia Ramos committed
25 26
Time Tracking uses two [quick actions](../user/project/quick_actions.md)
that GitLab introduced with this new feature: `/spend` and `/estimate`.
27

28
Quick actions can be used in the body of an issue or a merge request, but also
29 30
in a comment in both an issue or a merge request.

31
Below is an example of how you can use those new quick actions inside a comment.
32 33 34 35 36 37 38 39 40

![Time tracking example in a comment](time-tracking/time-tracking-example.png)

Adding time entries (time spent or estimates) is limited to project members.

### Estimates

To enter an estimate, write `/estimate`, followed by the time. For example, if
you need to enter an estimate of 3 days, 5 hours and 10 minutes, you would write
41 42
`/estimate 3d 5h 10m`. Time units that we support are listed at the bottom of
this help page.
43 44 45 46 47

Every time you enter a new time estimate, any previous time estimates will be
overridden by this new value. There should only be one valid estimate in an
issue or a merge request.

48
To remove an estimation entirely, use `/remove_estimate`.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66

### Time spent

To enter a time spent, use `/spend 3d 5h 10m`.

Every new time spent entry will be added to the current total time spent for the
issue or the merge request.

You can remove time by entering a negative amount: `/spend -3d` will remove 3
days from the total time spent. You can't go below 0 minutes of time spent,
so GitLab will automatically reset the time spent if you remove a larger amount
of time compared to the time that was entered already.

To remove all the time spent at once, use `/remove_time_spent`.

## Configuration

The following time units are available:
67 68 69 70 71 72

- months (mo)
- weeks (w)
- days (d)
- hours (h)
- minutes (m)
73

KyleK's avatar
KyleK committed
74
Default conversion rates are 1mo = 4w, 1w = 5d and 1d = 8h.
75

Marcia Ramos's avatar
Marcia Ramos committed
76
### Limit displayed units to hours **(CORE ONLY)**
77

Marcia Ramos's avatar
Marcia Ramos committed
78
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/29469/) in GitLab 12.1.
79

Marcia Ramos's avatar
Marcia Ramos committed
80 81
In GitLab self-managed instances, the display of time units can be limited to
hours through the option in **Admin Area > Settings > Preferences** under **Localization**.
82 83 84 85

With this option enabled, `75h` is displayed instead of `1w 4d 3h`.

## Other interesting links
86

87
- [Time Tracking landing page on about.gitlab.com](https://about.gitlab.com/solutions/time-tracking/)