CONTRIBUTING.markdown 3.18 KB
Newer Older
1 2
Herramientas
============
3

4
## [git](http://git-scm.com) con [git-flow](https://github.com/nvie/gitflow).
5 6 7 8 9 10 11 12 13 14 15

Configuración:

* master   => master
* develop  => queue
* feature  => traduccion
* hotfix   => hotfix
* release  => edicion

Ver el archivo `.gitflow`.

16
### Propuesta de texto con `git-flow`
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

1.  Crear una nueva feature con el artículo a traducir

        git flow feature start nombre-del-articulo

2.  Agregar el texto (en formato markdown)

        git add nombre-del-articulo.mdwn

3.  Guardar el cambio

        git commit -m "Explicación de por qué publicar este artículo"

4.  Traducir un párrafo, agregar y guardar el cambio

        git commit -am "Tal vez un comentario sobre algunas elecciones de traducción..."

5.  Repetir 4 hasta terminar

    Traducir párrafo por párrafo es para facilitar la revisión, al contrastar
    directamente el párrafo original (eliminado) con el párrafo traducido
    (agregado) con un simple `git diff`, antes de realizar el commit, o con `git
    log -p` después.

6.  Si tenés un repositorio público (e.g. cuenta en
    [Github](http://github.com/)) de donde podamos incorporar tus cambios,
    pusheá la rama del artículo y avisanos.

        git push repositorio traduccion/nombre-del-articulo

7.  ¡Revisar! Mejor una persona diferente a la que tradujo

8.  Mergear en la rama *queue*

        git flow feature finish nombre-del-articulo

53
### Correcciones después de publicado
54 55 56 57 58 59 60 61 62

1.  Crear un hotfix

        git flow hotfix start nombre-del-articulo

2.  Corregir y cerrar el hotfix

        git flow hotfix finish nombre-del-articulo

63
### Sólo quiero/puedo revisar
64 65 66 67 68 69 70

Para ver los artículos traducidos pero que aún no se publicaron, podés usar

    git diff --name-only master queue

Cualquier revisión en cualquiera de esos artículos es bienvenida.

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
### Más información

* [Modelo de ramas](http://nvie.com/git-model)
* [Cheatsheet](http://danielkummer.github.io/git-flow-cheatsheet/)

## vim

En este repo hay un archivo `.vimrc` con configuraciones básicas para
mantener cierta coherencia en el diagramado de los textos. Si agregás
esto en tu `~/.vimrc`:

    set exrc

vim lee ese archivo del directorio actual, y no tenés que modificar
ninguna otra configuración.

Guía de estilo
==============

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
## ¡Quiero mi capital social!

Si tradujiste desde cero, o corregiste una traducción contrastando con
el artículo original, agregate a la lista de traductoras del artículo,
con nombre o nick y un mail si querés. Si corregiste a partir del texto
traducido (por ejemplo la ortografía o puntuación) agregate en la lista
de correctoras.

## Notas de traducción

Muchas veces las traducciones necesitan una explicación o una referencia
al original para no perder el contexto, y muchas otras veces es
interesante aclarar términos oscuros o de nicho para poder acercar los
textos a gente fuera del ambiente. En esos casos usamos notas de traducción así:

105
    Texto con término confuso[^ndt-nombre-de-la-nota] y bla bla,
106 107
    sigue el párrafo hasta el final.

108 109 110 111
    [^ndt-nombre-de-la-nota]: Explicación. _(Nota de traducción)_

Siempre empezá con `[^ndt-]` para diferenciar más fácilmente las notas
que son de traducción de las notas en el texto original.