Project

General

Profile

How to use ctt » History » Version 8

Sanghee Kim, 02/01/2020 11:03 PM

1 1 Jin-Guk Kwon
h1. How to use ctt
2
3
h2. General Ticket handling
4
5
* Tickets which are not in progress for the moment needs to be set as unassigned & seen
6
* New Tickets, should be unassigned & new
7
** these tickets need to be watched and changed in 1 day
8
9
h2. Introduction
10
11
* Installation of "ctt":https://code.ungleich.ch/ungleich-public/ctt.git (or compatible) (*[[for windows user]])
12
** clone the repository to a location you whish
13
<pre>
14
git clone https://code.ungleich.ch/ungleich-public/ctt.git ~/Work/bin/ctt
15
</pre>
16
** Edit your PATH environment variable
17
*** e.g. open your ~/.bashrc and append
18
<pre>
19
export PATH=$PATH:~/Work/bin/ctt/bin
20
</pre>
21
*** source your ~/.bashrc
22
<pre>
23
source ~/.bashrc
24
</pre>
25
** if you run "ctt" now you should see the usage of it
26
* *Send Dominique your ssh key, otherwise the next steps won't work*
27
* Clone the dot-ctt repository from git@code.ungleich.ch:ungleich/dot-ctt.git
28
<pre>
29
git clone git@code.ungleich.ch:ungleich/dot-ctt.git ~/.ctt
30
</pre>
31
* Track your time to "$customer-$yourname" (ctt track $customer-$yourname <ENTER>) for instance
32
** ungleich-$YOURNAME
33
** customer1-$YOURNAME
34
** customer2-$YOURNAME
35
* When you finished working, press <ENTER> once again then give a comment what you worked on (See details below)
36
* All times need to be pushed every friday
37
<pre>
38
cd ~/.ctt
39
git pull
40
git add ./*
41
git commit -m "added times"
42
git push
43
</pre>
44
* If working for a customer of a customer, include the customer/project name:
45
** IDENTIFIER; normal text
46
* When working on a *fixed budget* project for a customer, book the hours to ungleich
47 7 Sanghee Kim
* If you are working at/for ungleich, your ctt entries will be reviewed, and logs not meeting the following criteria can/will be rejected.
48
** Time tracking *should not exceed 180 minutes* for one session of work
49 8 Sanghee Kim
*** If working on the same task for a long period of time, break it down. Avoid giving the same, repeated description for many entries over extensive hours. 
50
** Write a good and concise description of the work done per entry.
51
** Show the transparent progress of your task in the description.
52 1 Jin-Guk Kwon
53
h3. Deleting tracked time entry
54
55
<pre>
56
rm -r ~/.ctt/$customer-$yourname/YYYY-MM-DD-HHmm
57
</pre>
58
59
Where YYYY-MM-DD-HHmm is the start time of your tracked entry.
60
61
e.g.
62
63
<pre>
64
rm -r ~/.ctt/ungleich-intern-user/2015-08-26-2030
65
</pre>
66
67
68
h3. Change the comment
69
70
The comment is stored in the following file:
71
72
<pre>
73
~/.ctt/$customer-$yourname/YYYY-MM-DD-HHmm/comment
74
</pre>
75
76
Just open this file with a text editor (e.g. vim, nano, Notepad++ etc. (NOT WORD)) and change it's content
77
78
h2. Times & Dates
79
80
* Enter times until friday every week (everybody)
81
* Verify time entries until sunday evening (Nico)
82
* Transfer times to customer systems until monday midday (David)
83
84
h2. Some time-entry examples
85
86 3 Jin-Guk Kwon
* You work for a Ticket of Customer
87 1 Jin-Guk Kwon
88
<pre>
89 4 Jin-Guk Kwon
ctt track customer-$YOURNAME
90 1 Jin-Guk Kwon
Comment = Customer; #TICKETNUMBER; Comment
91
</pre>
92
93
* You work internal hours
94
95
<pre>
96
ctt track ungleich-$YOURNAME
97
comment = Ungleich; (#TICKETNUMBER); Comment
98
</pre>
99
100 2 Jin-Guk Kwon
* You work on fix price Project of Customer
101 1 Jin-Guk Kwon
102
<pre>
103 2 Jin-Guk Kwon
ctt track ungleich-customer-$YOURNAME
104
comment = Customer; (#TICKETNUMBER); Comment
105 1 Jin-Guk Kwon
</pre>
106
107
* You worked on a project but forgot to track:
108
109
<pre>
110
ctt track ungleich-intern-$YOURNAME --sd YYYY-MM-DD-HHMM --ed YYYY-MM-DD-HHMM
111
comment = COMMENT
112
</pre>
113
You can leave the --ed part if you still working on it now
114
115
h2 Reporting your time
116
117
<pre>
118
cd .ctt
119
ctt report *${YOURNAME}
120
</pre>