Skip to content

Commit 084a8e9

Browse files
committed
docs(contributing): improve formatting
1 parent 2e4367a commit 084a8e9

File tree

2 files changed

+43
-17
lines changed

2 files changed

+43
-17
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33
## Configuración de origin
44

55
- `origin`: Manejo del repositorio `angular/angular`como un submódulo.
6-
- `adev-es`: Se administra el contenido de la documentación de Angular, aquí se encuentran los archivos traducidos y no traducidos en formato markdown.
6+
- `adev-es`: Se administra el contenido de la documentación de Angular, aquí se encuentran los
7+
archivos traducidos y no traducidos en formato markdown.
78

89
## Configuración del directorio de adev
910

10-
Básicamente traduce archivos de Markdown en el directorio `content`. Si es necesario, también puede agregar el código fuente de la aplicación.
11+
Básicamente, traduce archivos de Markdown en el directorio `content`. Si es necesario, también
12+
puede agregar el código fuente de la aplicación.
1113

1214
```
1315
origin/adev/
@@ -27,31 +29,44 @@ origin/adev/
2729

2830
## Creación de un problema de traducción
2931

30-
Antes de comenzar el trabajo de traducción, vamos a comprobar si no hay nadie que está tratando de traducir el mismo archivo. Si miras la etiqueta de [docs-translation](https://github.com/angular-hispano/angular-docs-es/labels/docs-translation), puedes ver el área en la que se está trabajando actualmente en la traducción. Si desea hacer una nueva traducción, primero cree un [problema en Github](https://github.com/angular-hispano/angular-docs-es/issues) y complete la información de acuerdo con la plantilla.
32+
Antes de comenzar el trabajo de traducción, vamos a comprobar si no hay nadie que está tratando de
33+
traducir el mismo archivo. Si miras la etiqueta de [docs-translation](https://github.com/angular-hispano/angular-docs-es/labels/docs-translation), puedes ver el área en
34+
la que se está trabajando actualmente en la traducción. Si desea hacer una nueva traducción,
35+
primero cree un [problema en Github](https://github.com/angular-hispano/angular-docs-es/issues) y complete la información de acuerdo con la plantilla.
3136

3237
## Crear una solicitud de extracción de traducción
3338

34-
Empuja los cambios al repositorio donde bifurcaste `angular/angular-docs-es` y envía una solicitud de extracción a la fuente de bifurcación. Las solicitudes de extracción se revisan y luego se fusionan si no hay problemas.
39+
Empuja los cambios al repositorio donde bifurcaste `angular/angular-docs-es` y envía una solicitud
40+
de extracción a la fuente de bifurcación. Las solicitudes de extracción se revisan y luego se
41+
fusionan si no hay problemas.
3542

3643
## Directrices para la traducción
3744

3845
Para traducciones al español, por favor sigue las siguientes pautas.
3946

4047
### Guarda el texto original como un archivo.en.md
4148

42-
Para gestionar el `diff` del texto original después de actualizar el origen, guarda el original en el momento de la traducción como un archivo `xx.en.md`. Si desea traducir un documento nuevo, copie el archivo `xx.md` escrito en inglés al archivo `xx.en.md` y sobrescriba el archivo `xx.md` con la traducción al español.
49+
Para gestionar el `diff` del texto original después de actualizar el origen, guarda el original en
50+
el momento de la traducción como un archivo `xx.en.md`. Si desea traducir un documento nuevo,
51+
copie el archivo `xx.md` escrito en inglés al archivo `xx.en.md` y sobrescriba el archivo `xx.md`
52+
con la traducción al español.
4353

44-
Si la traducción es parcial y no del documento completo, no necesitas duplicar/crear el archivo `xx.en.md` simplemente puedes trabajar sobre el archivo `xx.md` con la traducción al español.
54+
Si la traducción es parcial y no del documento completo, no necesitas duplicar/crear el archivo
55+
`xx.en.md` simplemente puedes trabajar sobre el archivo `xx.md` con la traducción al español.
4556

4657
### Alinear la posición de salto de línea con la original
4758

48-
Siempre que sea posible, alinear el número de líneas en la fuente y la traducción, y ayudar a hacer la comprobación de diferencias más fácil al actualizar.
59+
Siempre que sea posible, alinear el número de líneas en la fuente y la traducción, y ayudar a hacer
60+
la comprobación de diferencias más fácil al actualizar.
4961

5062
### Recomendaciones
5163

52-
- Bifurca este repositorio en tu espacio de trabajo de Github para poder colaborar de una manera más limpia y ordenada.
64+
- Bifurca este repositorio en tu espacio de trabajo de Github para poder colaborar de una manera más
65+
limpia y ordenada.
5366

54-
- Se recomienda encarecidamente firmar todos los commits que envíes al repositorio. Esto ayudará a mantener la integridad y la seguridad del código base, y a fomentar un entorno de colaboración más confiable entre los desarrolladores.
67+
- Se recomienda encarecidamente firmar todos los commits que envíes al repositorio. Esto ayudará a
68+
mantener la integridad y la seguridad del código base, y a fomentar un entorno de colaboración más
69+
confiable entre los desarrolladores.
5570

5671
## Configura tu entorno local
5772

@@ -78,15 +93,20 @@ $ npm install
7893

7994
### 4. Servidor de desarrollo
8095

81-
Al iniciar el servidor local de desarrollo, puede traducir mientras comprueba el resultado de la compilación.
96+
Al iniciar el servidor local de desarrollo, puede traducir mientras comprueba el resultado de la
97+
compilación.
8298

8399
```
84-
$ npm run start
100+
$ npm start
85101
```
86102

87-
El navegador se iniciará automáticamente cuando el servidor local esté listo `adev-es` será reconstruido automáticamente al cambiar un archivo en el directorio.
103+
El navegador se iniciará automáticamente cuando el servidor local esté listo `adev-es` será
104+
reconstruido automáticamente al cambiar un archivo en el directorio.
88105

89-
Toma en cuenta que, si es la primera vez que están iniciando el servidor, debes pasar como argumento `-- --init` lo cual hará que se inicilice de nuevo el folder `build` y así evitar problemas de caché. Puedes pasar este argumento cada vez que necesites inicializar nuevamente el folder `build`.
106+
Toma en cuenta que, si es la primera vez que están iniciando el servidor, debes pasar como
107+
argumento `-- --init` lo cual hará que se inicilice de nuevo el folder `build` y así evitar
108+
problemas de caché. Puedes pasar este argumento cada vez que necesites inicializar nuevamente el
109+
folder `build`.
90110

91111

92112
### 5. Construye para producción
@@ -97,16 +117,22 @@ $ npm run start
97117
$ npm run build
98118
```
99119

100-
Cuando se completa la compilación, el resultado de la compilación se envía al directorio `build/dist/bin/adev/build`. Puedes configurar un servidor de desarrollo con tu herramienta favorita y comprobar los sitios construidos.
120+
Cuando se completa la compilación, el resultado de la compilación se envía al directorio
121+
`build/dist/bin/adev/build`. Puedes configurar un servidor de desarrollo con tu herramienta
122+
favorita y comprobar los sitios construidos.
101123

102124
Construye el proyecto en CI
103125

104126
```
105127
$ npm run build:ci
106128
```
107129

108-
La compilación del proyecto en CI funciona de manera diferente, primero ejecutamos el comando `npm run build:ci`, este comando realizará un `pre-built` del proyecto, es decir que no construirá la documentación y solo creará el directorio `build` y copiará los archivos necesarios. La construcción de la documentación se realizará directamente en la configuración de CI.
130+
La compilación del proyecto en CI funciona de manera diferente, primero ejecutamos el comando
131+
`npm run build:ci`, este comando realizará un `pre-built` del proyecto, es decir que no construirá
132+
la documentación y solo creará el directorio `build` y copiará los archivos necesarios. La
133+
construcción de la documentación se realizará directamente en la configuración de CI.
109134

110135
## Gracias por tu colaboración!
111136

112-
Esperamos que te unas a nosotros en este esfuerzo por hacer que la documentación de Angular sea más accesible para la comunidad hispanohablante.
137+
Esperamos que te unas a nosotros en este esfuerzo por hacer que la documentación de Angular sea más
138+
accesible para la comunidad hispanohablante.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ Revisa la guia de actualización en [UPDATE-ORIGIN.md](./UPDATE-ORIGIN.md)
1818

1919
## Comunidad
2020

21-
Puedes unirte a nuestra comunidad en [Angular Hispano Discord](https://discord.gg/zRsMufaS)
21+
Puedes unirte a nuestra comunidad en [Angular Hispano Discord](https://discord.gg/zRsMufaS)

0 commit comments

Comments
 (0)