debian-mirror-gitlab/doc/workflow/time_tracking.md

92 lines
2.9 KiB
Markdown
Raw Normal View History

2019-12-04 20:38:33 +05:30
---
type: reference
---
2017-08-17 22:00:37 +05:30
# Time Tracking
> Introduced in GitLab 8.14.
Time Tracking allows you to track estimates and time spent on issues and merge
requests within GitLab.
## Overview
2019-12-21 20:55:43 +05:30
Time Tracking allows you to:
2019-03-02 22:35:43 +05:30
- 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
2019-07-07 11:18:12 +05:30
request.
2017-08-17 22:00:37 +05:30
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.
2019-12-04 20:38:33 +05:30
![Time tracking in the sidebar](time_tracking/img/time_tracking_sidebar_v8_16.png)
2017-08-17 22:00:37 +05:30
## How to enter data
2019-10-12 21:52:04 +05:30
Time Tracking uses two [quick actions](../user/project/quick_actions.md)
that GitLab introduced with this new feature: `/spend` and `/estimate`.
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
Quick actions can be used in the body of an issue or a merge request, but also
2017-08-17 22:00:37 +05:30
in a comment in both an issue or a merge request.
2017-09-10 17:25:29 +05:30
Below is an example of how you can use those new quick actions inside a comment.
2017-08-17 22:00:37 +05:30
2019-12-04 20:38:33 +05:30
![Time tracking example in a comment](time_tracking/img/time_tracking_example_v12_2.png)
2017-08-17 22:00:37 +05:30
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
2019-07-07 11:18:12 +05:30
`/estimate 3d 5h 10m`. Time units that we support are listed at the bottom of
this help page.
2017-08-17 22:00:37 +05:30
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.
2019-07-07 11:18:12 +05:30
To remove an estimation entirely, use `/remove_estimate`.
2017-08-17 22:00:37 +05:30
### 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:
2019-03-02 22:35:43 +05:30
2019-12-04 20:38:33 +05:30
- Months (mo)
- Weeks (w)
- Days (d)
- Hours (h)
- Minutes (m)
2017-08-17 22:00:37 +05:30
2019-02-15 15:39:39 +05:30
Default conversion rates are 1mo = 4w, 1w = 5d and 1d = 8h.
2017-08-17 22:00:37 +05:30
2019-10-12 21:52:04 +05:30
### Limit displayed units to hours **(CORE ONLY)**
2019-09-30 21:07:59 +05:30
2019-12-04 20:38:33 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/29469/) in GitLab 12.1.
2019-09-30 21:07:59 +05:30
2019-10-12 21:52:04 +05:30
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**.
2019-09-30 21:07:59 +05:30
With this option enabled, `75h` is displayed instead of `1w 4d 3h`.
## Other interesting links
2019-07-07 11:18:12 +05:30
2019-12-04 20:38:33 +05:30
- [Time Tracking landing page in the GitLab handbook](https://about.gitlab.com/solutions/time-tracking/)