TOC(heading=Índice)?

Buen uso del gestor de proyectos

Introducción

El grupo de desarrollo de OpenGnSys ha optado por utilizar el gestor de proyectos Trac y el repositorio de código Subversion. En esta página se presenta una breve lista de recomendaciones a la hora de utilizar estas herramientas.

Wiki

Consideraciones generales

• Seguir las normas de Trac para formatear la información (ver WikiFormatting).
• Los nombres de las páginas del wiki deben seguir la nomenclatura recomendada por Trac (ver WikiPageNames).
• El idioma por defecto de las páginas es el español.
• Una página traducida debe crearse con el nombre Página/Idioma, indicando el nombre abreviado para el idioma, por ejemplo en para inglés (ver WikiNewPage).

Estructura recomendada

• Para una página con traducción o en el caso de que vaya a ser traducida, ésta debe empezar con la macro:

  [[TranslatedPages]]
  

• Todas las páginas del wiki deben incluir un índice.
  • Para información en español añadir la macro:

    [[TOC(heading=Índice)]]
    

  • Para páginas en inglés, añadir:

    [[TOC]]
    

• Puede indicarse una información destacada en un recuadro de noticias, incluyendo la macro:

  {{{
  #!NewsFlash
  Información
  }}}
  

• Sólo debe incluirse una cabecera de primer nivel indicando el título de la página (no será incluido en el índice):

  = Título =
  

• Pueden incluirse tantos subtítulos de distinto nivel como se considere oportuno, manteniendo una estructura correcta para el índice de la página.
• Las referencias a otras páginas del wiki, incidencias, listas de cambios, direcciones externas, etc., deben seguir las recomendaciones establecidas por Trac (ver TracLinks).
• Puede añadirse cualquier macro instalada en el sistema (ver WikiMacros).
• Asimismo, el texto puede formatearse para ofrecer un aspecto personalizado, tablas complejas o resaltar código (ver WikiProcessors).
• Incluir las etiquetas adecuadas para el buscador del portal, según las recomendaciones establecidas.
• Incluir siempre una breve descripción de los cambios aplicados en la página.

Incidencias

• descripción completa
• campos
• etiquetas
• revisiones de código

Etiquetas

• Una etiquete debe ser una única palabra escrita siempre en minúsculas (por ejemplo opengnsys)
• Usar el carácter guión para agrupar varias palabras en una única etiqueta (por ejemplo sistema-de-archivos).
• Añadir tantas etiquetas de búsqueda como sean necesarias para calificar adecuadamente el contenido de la página.
• Verificar que las etiquetas existen en la lista antes de incluir alguna nueva (ver tags).

Revisiones de código

• resumen
• incidencias