-
Notifications
You must be signed in to change notification settings - Fork 422
/
codeReviews.html
57 lines (35 loc) · 5.62 KB
/
codeReviews.html
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
<!-- #### CODE REVIEWS SECTION #### -->
<section id="codereviews">
<div class="intro has-icon">
<img class="icon" src="img/icon-curly.png" alt="{}" />
<h1>Revisiones de Código</h1>
<p>Una revisión de código es la piedra angular del proceso formal para garantizar la calidad de las experiencias de usuario desarrolladas por el equipo de Tecnología Creativa. Se trata de una reunión entre los autores del etiquetado, los revisores y otras partes interesadas, con el aporte esperado y posteriores revisiones de código. En pocas palabras, promovemos la conducción de revisiones de código para mantener nuestras herramientas nítidas y limpias.</p>
</div>
<strong>¿Por qué debería hacer una revisión de código?</strong>
<p>Las revisiones de código son una inversión estratégica de tiempo para mitigar el riesgo en un proyecto.</p>
<p>Muchas veces, a los desarrolladores de la interfaz se les pide que creen el etiquetado a partir de los wireframes o composiciones visuales. Sin embargo, es posible que las pantallas que se han diseñado no se puedan traducir al etiquetado con facilidad o sin comprometer la calidad. Las revisiones de código brindan una oportunidad para que este riesgo sea abordado y resuelto antes de que comience la producción completa de las páginas.</p>
<strong>Las revisiones de código aumentan el nivel general de conocimiento entre los proyectos</strong>
<p>Dado que las revisiones de código involucran a miembros de dentro y fuera de un equipo de proyecto, las técnicas y prácticas recomendadas son compartidas fácilmente a lo largo de todo el equipo de Tencnología Creativa.</p>
<strong>Las revisiones de código eliminan los errores antes de que se reproduzcan de unas pocas plantillas a múltiples páginas</strong>
<p>Idealmente, las revisiones de código se llevan a cabo al inicio del proceso de desarrollo, antes de que comience la producción completa de las páginas. Cuando las plantillas son revisadas por el equipo y pasadas a través de las herramientas de validación y navegadores, los errores pueden y van a aparecer. Este es el momento ideal para que los errores se corrijan.</p>
<strong>Las revisiones de código le dan a un conjunto de ojos frescos la oportunidad de detectar problemas en el código</strong>
<p>Los revisores de fuera de un equipo de proyecto pueden detectar problemas con el código más fácilmente que los autores del etiquetado, quienes han estado trabajando con el código por un largo período de tiempo.</p>
<strong>¿Quién debe participar en una revisión de código?</strong>
<p>En última instancia, se requiere que el lider de Ingeniería de Front-end en un proyecto garantice que se sigan los procedimientos apropiados de revisión de código.</p>
<p>Idealmente, el lider del equipo debe actuar como facilitador para una sesión de revisión de código, a menos que el lider del equipo sea tambien el desarrollador de la interfaz cuyo código se encuentra bajo revisión. En esta situación, un gerente de proyecto puede integrarse como facilitador.</p>
<p>El equipo de revisión debe incluir al menos dos miembros senior del equipo de Tecnología de Interfaz versados en desarrollo y prácticas recomendadas.</p>
<strong>¿Qué se requiere para una revisión de código?</strong>
<p>Antes de que se lleve a cabo una revisión de código, las plantillas a ser revisadas deben estar completamente desarrolladas, validadas y probadas en los navegadores y plataformas requeridas por el proyecto.</p>
<p>Un lider de equipo y/o desarrollador de interfaz debe distribuir las siguientes 48 horas antes de la fecha de la revisión de código:</p>
<ul>
<li>El código para todas las páginas, server-side includes asociados, CSS y JavaScript. Éstos deben estar completamente comentados, impresos con los números de línea a lo largo del lado izquierdo y el nombre del archivo/página en el pie de cada página impresa.</li>
<li>Capturas de pantalla de cada plantilla</li>
<li>Direcciones URL de las plantillas, si procede</li>
<li>Una lista de navegadores y plataformas soportadas por el proyecto</li>
<li>Una lista de problemas conocidos/áreas de interés</li>
</ul>
<p>Es típico que el código deba cambiar constantemente hasta que la revisión del código se lleve a cabo. Desafortunadamente, esto no deja tiempo suficiente para la validación y las pruebas. Si este es el caso, se recomienda que la revisión del código se aplace para una fecha que asegure una revisión del código adecuada.</p>
<p>Además, un lider de equipo y/o desarrollador de interfaz debe reservar una sala de conferencias y un número de llamada para todos los asistentes, ya que es posible que miembros del equipo del proyecto o del equipo de revisión de código estén fuera del sitio. Una hora debería ser suficiente tiempo para la revisión de dos o tres plantillas, sin embargo, el tiempo variará dependiendo del volumen y la complejidad de las plantillas.</p>
<p>Durante la revisión de código, un lider de equipo y/o desarrollador de interfaz debe conducir la reunión, mientras que el lider de equipo o gerente del proyecto toma notas y asigna puntos de acción. Los revisores deben haber revisado el código con anterioridad y asistir preparados para hacer preguntas o proporcionar feedback.</p>
<p>Las notas y puntos de acción deben ser distribuidos a todos los asistentes después de la revisión del código. Si resultan cambios sustanciales de una revisión de código, o no se revisa todo el código, puede ser necesario programar una segunda revisión del código. Sin embargo, esto debe ser discutido entre el equipo del proyecto para determinar su viabilidad.</p>
</section>