tc2005b.github.io/code_reviews.html at main · black4ninja/tc2005b.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
<!DOCTYPE html>
<html lang="es-mx">

<head>
    <!--Import materialize.css-->
    <link type="text/css" rel="stylesheet" href="css/materialize.min.css" media="screen,projection" />
    <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">

    <!--Let browser know website is optimized for mobile-->
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />

    <meta content="text/html; charset=UTF-8" http-equiv="content-type">
    <title>Política de trabajo en equipo</title>
</head>

<body>
    <header></header>

    <main>

        <div class="navbar-fixed">
            <nav>
                <div class="blue darken-1 nav-wrapper">
                    <a href="index.html" class="brand-logo"><acronym title="Construcción de software y toma de decisiones">TC2005B</acronym></a>
                </div>
            </nav>
        </div>

        <div class="container">
            <div class="section">

                <h3>Política de trabajo en equipo</h3>
            </div>
        </div>

        <div class="container">

            <div class="section" id="descripcion">
                <h5>
                  <i class="small mdi-action-info-outline"></i>
                  Descripción
                </h5>
                <p>Una política es un principio de gobierno, típicamente usado como la base para la definición de procedimientos dentro de una organización. En nuestro caso, la política de trabajo en equipo, tiene como propósito maximizar el desarrollo de habilidades y la efectividad de los miembros del equipo, además de mejorar la calidad del producto final por medio de la detección temprana de defectos. </p>
                <p>Las revisiones de código y la programación en parejas son buenas prácticas de la industria para remover defectos en el software y al mismo tiempo promueven el desarrollo de habilidades. Es por ello que incorporaremos estas prácticas en nuestro trabajo diario.</p>
                <div class="divider"></div>
            </div>

            <div class="section" id="modalidad">
                <h5>
                  <i class="small mdi-social-group"></i>
                  Modalidad
                 </h5>
                <p>
                    En pares.
                    <br />
                </p>
                <div class="divider"></div>
            </div>

            <div class="section" id="objetivos">
                <h5><i class="small mdi-navigation-check"></i>
                    Objetivos
                </h5>
                <ul class="collection with-header">
                    <li class="collection-item"><i class="small mdi-image-looks-one"></i>Encontrar defectos en el código</li>
                    <li class="collection-item"><i class="small mdi-image-looks-two"></i>Desarrollar tus habilidades aprendiendo de los demás</li>
                    <li class="collection-item"><i class="small mdi-image-looks-3"></i>Transmitir tus habilidades</li>
                    <li class="collection-item"><i class="small mdi-image-looks-4"></i>Brindar y recibir retroalimentación de manera oportuna</li>
                    <li class="collection-item"><i class="small mdi-image-looks-5"></i>Crear una comunidad de aprendizaje activo</li>
                </ul>
                <div class="divider"></div>
            </div>

            <div class="section" id="instrucciones">
                <h5><i class="small mdi-action-list"></i>
                    Política de trabajo en equipo
                </h5>
                <ul class="collection">
                    <li class="collection-item">
                        <p>Es una buena práctica que vayas creando <em>commits</em> cada vez que avances en tu trabajo, esto permite ver el trabajo realizado y gestionar las versiones de tu código para que puedas modificarlo con confianza.</p>
                    </li>
                    <li class="collection-item">
                        <p>En la medida de lo posible, procura que todo tu trabajo en el proyecto se realice con la práctica Pair Programming. Incluso, puedes aplicar esta práctica también en los laboratorios.</p>
                        <p>La practica de Pair Programming, básicamente consiste en que 2 personas trabajan en 1 tarea, compartiendo 1 sola pantalla y teclado. Esto permite que el observador guíe y encuentre defectos en el momento que se inyectan, además de que ambos mejoran sus habilidades tanto de observar, como de la retroalimentación que reciben.</p>
                        <p>Para que esta práctica sea efectiva, traten de trabajar sin distracciones en periodos de alrededor de 45min + 10min de descanso, y ajusten conformen se sienten más cómodos y productivos. </p>
                        <p>Es indispensable un ambiente de respecto, confianza y altamente constructivo. El trabajo no debe realizarse para juzgar al compañero, sino para que ambos mejoren sus habilidades y para que mejore la calidad del producto.</p>
                    </li>
                    <li class="collection-item">
                        <p>Para el trabajo que no se realice en parejas, es posible también transferir habilidades y mejorar su calidad por medio de las revisiones de código.</p>
                        <p>Idealmente, antes de integrar a la rama <code>develop</code>, es importante crear un <em>Pull Request</em> y asignar como revisores a 2 miembros de tu equipo.</p>
                        <p>Para los revisores, se espera que además de encontrar defectos de claridad en el código, documentación, seguridad, eficiencia, y buenas prácticas, apoyen a los autores en mejorar su práctica o aprendan algo de ellos. Por lo que se pide que en la revisión, hagan comentarios enfocados en lo que sus compañeros pueden mejorar, o en lo que aprendieron del código que revisaron.</p>
                        <p>La retroalimentación debe ser <strong>constructiva y significativa</strong>. Es decir, no se aceptarán comentarios ofensivos hacia la persona, ni que desprecien el trabajo. De ser necesario incluye material de apoyo como un artículo. Describe claramente lo que se puede mejorar y cómo realizarlo, así como lo que potencialmente podría causar problemas. O bien, específicamente las lecciones aprendidas del código que se revisó.</p>
                    </li>
                </ul>
                <div class="divider"></div>
            </div>

            <div class="section" id="recursos">
                <h5><i class="small mdi-content-link"></i>
                  Recursos
                </h5>
                <ul class="collection">
                    <li class="collection-item">
                        <a href="https://martinfowler.com/articles/on-pair-programming.html" class="collection-item">
                            On Pair Programming
                        </a>
                    </li>
                    <li class="collection-item">
                        <a href="https://medium.engineering/the-code-review-mindset-3280a4af0a89" class="collection-item">
                            The Code Review Mindset
                        </a>
                    </li>
                    <li class="collection-item">
                        <a href="https://medium.com/listen-to-my-story/why-i-code-reviews-a2f3df8037a3" class="collection-item">
                            Why I Love Code Reviews
                        </a>
                    </li>
                    <li class="collection-item">
                        <a href="https://slack.engineering/how-about-code-reviews-2695fb10d034" class="collection-item">
                            How About Code Reviews?
                        </a>
                    </li>
                </ul>

                <div class="divider"></div>
            </div>
        </div>
    </main>

    <footer class="blue darken-1 page-footer">
        <div class="container">
            <div class="row">
                <div class="col">
                    <h5 class="white-text">Secciones</h5>
                    <ol class="grey-text text-lighten-3">
                        <li><a class="grey-text text-lighten-3" href="#descripcion">Descripción</a></li>
                        <li><a class="grey-text text-lighten-3" href="#modalidad">Modalidad</a></li>
                        <li><a class="grey-text text-lighten-3" href="#objetivos">Objetivos</a></li>
                        <li><a class="grey-text text-lighten-3" href="#instrucciones">Instrucciones</a></li>
                        <li><a class="grey-text text-lighten-3" href="#recursos">Recursos</a></li>
                    </ol>
                </div>
            </div>
            <p class="grey-text text-lighten-4">Powered by <a href="http://materializecss.com/" target="_blank" class="white-text text-lighten-4">Materialize</a>.</p>
        </div>
        <div class="footer-copyright">
            <div class="container">
                © 2021 Escuela de Ingeniería y Ciencias - Tecnológico de Monterrey en Querétaro
            </div>
        </div>
    </footer>


    <!--Import jQuery before materialize.js-->
    <script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
    <script type="text/javascript" src="js/materialize.min.js"></script>
</body>

</html>