Skip to content
This repository was archived by the owner on Sep 22, 2023. It is now read-only.

Commit e941e13

Browse files
author
mprcodes
committed
update informational .md files
1 parent a912219 commit e941e13

File tree

3 files changed

+49
-56
lines changed

3 files changed

+49
-56
lines changed

CONTRIBUTING.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Usa el ícono de la tabla de contenido en la esquina superior izquierda de este
1212

1313
## Traduciendo las páginas
1414

15-
La traducción al español de [_The Swift Programming Language_](https://docs.swift.org/swift-book/) consiste en una serie de páginas maquetadas mediante [MDX](https://mdxjs.com/) que luego son renderizadas por [Nextra](https://github.com/shuding/nextra) y son las que consumimos día a día, cada uno de estos archivos markdown (`.mdx`) corresponde a una página del libro. En [Progreso de Traducción](https://github.com/trsplms/swift-book-es/issues/3), podrás encontrar una lista de todas las páginas que se deben traducir; este es, a su vez, un issue de progreso para llevar un seguimiento y registro de las traducciones.
15+
La traducción al español de [_The Swift Programming Language_](https://docs.swift.org/swift-book/) consiste en una serie de páginas maquetadas mediante [MDX](https://mdxjs.com/) que luego son renderizadas por [Nextra](https://github.com/shuding/nextra) y son las que consumimos día a día. Cada uno de estos archivos markdown (`.mdx`) corresponde a una página del libro. En [Progreso de Traducción](https://github.com/trsplms/swift-book-es/issues/3), podrás encontrar una lista de todas las páginas que se deben traducir; este es, a su vez, un issue de progreso para llevar un seguimiento y registro de las traducciones.
1616

1717
<br />
1818

@@ -22,27 +22,27 @@ Buscando mantener un orden en las traducciones, contamos con el issue de progres
2222

2323
1. Dirígete al issue de [Progreso de Traducción](https://github.com/trsplms/swift-book-es/issues/3) y verifica cuáles páginas pendientes por traducción están disponibles.
2424

25-
2. Si ya sabes cuál página quieres traducir, deja un comentario etiquetándome (@trsplms) con la página que quieres traducir, para así poder asignártela.
25+
2. Si ya sabes cuál página quieres traducir, deja un comentario etiquetándome (@patternina) con la página que quieres traducir, para así poder asignártela.
2626

2727
3. Espera una respuesta en los comentarios o revisa que la página que deseas traducir ya tiene tu nombre de usuario al lado entre paréntesis:
2828

29-
> Fundamentos.mdx (@trsplms)
29+
> Fundamentos.mdx (<tu nombre de usuario>) ✍🏽
3030
3131
De esta forma ya sabes que puedes empezar a traducir.
3232

33-
4. Empieza a traducir. Si no sabes cómo empezar, en la siguiente parte te indico cómo hacer un fork del repositorio, clonarlo, y cómo abrir tu primer PR.
33+
4. Empieza a traducir. Si no sabes cómo empezar, en la siguiente parte te indico cómo hacer un _fork_ del repositorio, clonarlo, y cómo abrir tu primer PR.
3434

3535
<br />
3636

37-
## Crear un fork, clonar
37+
## Crear un _fork_, clonar
3838

39-
Para empezar a traducir y crear tu primera contribución, debes crear un fork del repositorio, que no es más que hacer una copia del repositorio base a tus repositorios; de esta manera, evitamos choques no deseados con el contenido oficial. Seguidamente, clonarás tu repositorio a tu máquina local para tener todo el código de las páginas y, así, poder abrirlas en tu editor de texto. Finalmente, cuando termines de traducir una página, pódras crear tu primer PR para su revisión. Parece mucho, pero sigue estas instrucciones:
39+
Para empezar a traducir y crear tu primera contribución, debes crear un _fork_ del repositorio, que no es más que hacer una copia del repositorio base a tus repositorios; de esta manera, evitamos choques no deseados con el contenido oficial. Seguidamente, clonarás tu repositorio a tu máquina local para tener todo el código de las páginas y, así, poder abrirlas en tu editor de texto. Finalmente, cuando termines de traducir una página, pódras crear tu primer PR para su revisión. Parece mucho, pero sigue estas instrucciones:
4040

41-
1. Para crear un fork del repositorio, dirígete a la [página principal](https://github.com/trsplms/swift-book-es) del repositorio.
41+
1. Para crear un _fork_ del repositorio, dirígete a la [página principal](https://github.com/patternina/swift-book-es) del repositorio.
4242

43-
2. En la parte superior derecha, haz clic en el botón **Fork**. Esto creará un fork en tus repositorios. Al finalizar, estarás en una página similar a la del repositorio principal, solo que con tu nombre de usuario. También puedes hacer un fork de un repositorio usando el subcomando `gh repo fork`: `gh repo fork trsplms/swift-book-es`.
43+
2. En la parte superior derecha, haz clic en el botón **Fork**. Esto creará un _fork_ en tus repositorios. Al finalizar, estarás en una página similar a la del repositorio principal, solo que con tu nombre de usuario. También puedes hacer un fork de un repositorio usando el subcomando `gh repo fork`: `gh repo fork patternina/swift-book-es`.
4444

45-
3. Ahora, debes clonar el repositorio en tu máquina local; para esto, justo donde quedaste en el paso anterior dale clic en **Code**. Allí encontrarás la dirección de tu repositorio, cópiala y desde tu terminal, ejecuta `git clone <URL_DEL_REPOSITORIO>` pegando el enlace de tu repositorio para clonar. También puedes hacerlo con el subcomando `gh repo clone`: `gh repo clone trsplms/swift-book-es`.
45+
3. Ahora, debes clonar el repositorio en tu máquina local; para esto, justo donde quedaste en el paso anterior dale clic en **Code**. Allí encontrarás la dirección de tu repositorio, cópiala y desde tu terminal, ejecuta `git clone <URL_DEL_REPOSITORIO>` pegando el enlace de tu repositorio para clonar. También puedes hacerlo con el subcomando `gh repo clone`: `gh repo clone patternina/swift-book-es`.
4646

4747
4. Ya con el repositorio clonado, ábrelo en tu editor de texto. Ahora, debes crear una rama para trabajar.
4848

@@ -52,15 +52,15 @@ Para empezar a traducir y crear tu primera contribución, debes crear un fork de
5252

5353
Al terminar de clonar el repositorio, estarás trabajando sobre la rama principal (`main`) en tu repositorio local. Los cambios se deben realizar en una rama aparte ya que `main`, que incluye las traducciones finales, sirve como base de la página de producción. Por lo tanto, solo debes crear una nueva rama, traducir la página deseada y hacer _commit_ de los cambios:
5454

55-
1. Crea una nueva rama a partir de la rama principal (`main`) ejecutando en tu terminal: `git checkout -b <NOMBRE_DE_LA_NUEVA_RAMA>`, trata de que el nombre de la rama tenga concordancia con lo que estás realizando o traduciendo, por ejemplo: `git checkout -b translate-basic-operators`.
55+
1. Crea una nueva rama a partir de la rama principal (`main`) ejecutando en tu terminal: `git checkout -b <traduccion/NOMBRE_DEL_ARTICULO>`, el nombre de la rama debe componerse de la palabra `traduccion` seguido de un símbolo `/` y el nombre del artículo a traducir, por ejemplo: `git checkout -b traduccion/operadores-basicos`.
5656

5757
2. Ya estando en tu nueva rama, abre tu editor de texto favorito y empieza a traducir la página que solicitaste.
5858

5959
3. Al finalizar de traducir, debes hacer _commit_ de los cambios, esto para que el repositorio los guarde. Para esto debes agregar tus cambios ejecutando: `git add .` (asumiendo que solo modificaste un solo archivo). Asegúrate de solo agregar el archivo de la página que cambiaste, nada más.
6060

61-
4. Ahora debes agregar un comentario a tu _commit_, para esto ejecuta: `git commit -m "[translation]: <NOMBRE_DEL_ARCHIVO>"`, por ejemplo: `git commit -m "[translation]: Basic Operators"`.
61+
4. Ahora debes agregar un comentario a tu _commit_, para esto ejecuta: `git commit -m "[traduccion]: <NOMBRE_DEL_ARCHIVO>"`, por ejemplo: `git commit -m "[traduccion]: Operadores básicos"`.
6262

63-
5. Finalmente es hora de subir tus cambios, para esto baste con ejecutar: `git push origin` o `git push origin <NOMBRE_DE_LA_RAMA>`.
63+
5. Finalmente es hora de subir tus cambios, para esto baste con ejecutar: `git push origin` o `git push origin <traduccion/NOMBRE_DEL_ARTICULO>`.
6464

6565
6. Con los cambios de tu repositorio ya actualizados en Github, ahora solo resta crear un PR.
6666

@@ -93,7 +93,7 @@ Puedes encontrar más detalle sobre el estilo que deben llevar las traducciones
9393
- Cuida tu ortografía, es importante que la traducción presente una buena ortografía tanto en acentos como en palabras bien escritas.
9494
- No agregues o elimines líneas del contenido original; traduce siempre sobre las mismas líneas. Una forma fácil de comprobar esto es revisar que las primeras y últimas 10 líneas de la página tengan contenido igual o títulos, pero por supuesto traducidos.
9595
- Siempre trata de mantener un español neutro (asumiendo que tal cosa existe 😅), evita el uso de palabras altamente coloquiales o regionales a tu región o país, esto será evaluado más adelante por los mantenedores pero es de gran ayuda para mantener la documentación con un lenguaje neutral.
96-
- Si no conoces la traducción a una palabra puedes utilizar herramientas como [Google Translate](https://translate.google.com/), pero no traduzcas una página completa con este ya que el significado se puede perder.
96+
- Si no conoces la traducción a una palabra puedes utilizar herramientas como [DeepL](https://DeepL.com/), pero no traduzcas una página completa con este ya que el significado se puede perder.
9797
- Una buena forma de tener en cuenta aspectos como estos es crear una lista de checks en tu PR, por ejemplo:
9898

9999
- Traducción inicial

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Este repositorio contiene el código fuente, al igual que los archivos fuente (`
44

55
El contenido de este repo está basado en el libro [_The Swift Programming Language_](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/), con algunas algunas sugerencias y correcciones.
66

7-
Use el icono de la tabla de contenido en la esquina superior izquierda de este documento para llegar a una sección específica de esta guía rápidamente.
7+
Usa el ícono de la tabla de contenido en la esquina superior izquierda de este documento para llegar a una sección específica de esta guía rápidamente.
88

99
<br />
1010

@@ -22,11 +22,11 @@ En el [sitio web](https://swiftbook.es/), puedes hacer clic en el enlace `Editar
2222

2323
Para contribuciones más complejas, puedes abrir un _issue_ para describir los cambios que deseas proponer.
2424

25-
Si estás buscando una forma de contribuir, puedes consultar el [progreso de las traducciones](https://github.com/trsplms/swift-book-es/issues/3) o escanear nuestros [_issues existentes_](https://github.com/trsplms/swift-book-es/issues) por algo en lo que puedas trabajar. Cuando estés listo, visita la [guía de contribución](./CONTRIBUTING.md) para obtener instrucciones detalladas.
25+
Si estás buscando una forma de contribuir, puedes consultar el [progreso de las traducciones](https://github.com/patternina/swift-book-es/issues/3) o escanear nuestros [_issues existentes_](https://github.com/patternina/swift-book-es/issues) por algo en lo que puedas trabajar. Cuando estés listo, visita la [guía de contribución](./CONTRIBUTING.md) para obtener instrucciones detalladas.
2626

2727
### Únete a nosotros en discusiones
2828

29-
Utilizamos las discusiones de GitHub para discutir sobre todo tipo de temas relacionados con la traduccion, documentación, y mantenimiento de este sitio. Por ejemplo:, si deseas resolver una _pull request_, tienes una gran idea nueva, o quieres compartir algo asombroso que has aprendido gracias a las traducciones, únete a nosotros en las [discusiones](https://github.com/trsplms/swift-book-es/discussions).
29+
Utilizamos las discusiones de GitHub para discutir sobre todo tipo de temas relacionados con la traduccion, documentación, y mantenimiento de este sitio. Por ejemplo:, si deseas resolver una _pull request_, tienes una gran idea nueva, o quieres compartir algo asombroso que has aprendido gracias a las traducciones, únete a nosotros en las [discusiones](https://github.com/patternina/swift-book-es/discussions).
3030

3131
<br />
3232

STYLEGUIDE.md

+33-40
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
> Para conocer el estado y progreso actuales de la traducción, visita [Progreso de la traducción](https://github.com/trsplms/swift-book-es/issues/3)
1+
> Para conocer el estado y progreso actuales de la traducción, visita [Progreso de la traducción](https://github.com/patternina/swift-book-es/issues/3)
22
33
<br />
44
<br />
@@ -9,13 +9,40 @@ Sigue esta guía de estilo para, así, ser consistente con el resto de las pági
99

1010
<br />
1111

12-
## Texto en bloques de código
12+
## Bloques de código
13+
14+
[Nextra](https://nextra.site) tiene funcionalidad de _syntax highlighting_ integrada, por lo que para los bloques de código tienen el siguiente formato:
15+
16+
- El código va encerrado en dos líneas con tres _backticks_ (` \``) cada una. La primera fila, sin embargo lleva la palabra clave `swift`para indicar a Nextra que queremos _syntax highlighting_ para dicho lenguaje de programación. De igual, manera lleva la palabra clave`showLineNumbers` para indicarle a Nextra que queremos los números de línea visibles (esto no es implementado en la página web oficia del libro, pero es una preferencia personal).
17+
- Para resaltar una o varias líneas de código en un bloque, indíca los números de línea dentro de llaves (`{}`) —separados por comas (`,`) si se trata de líneas no consecutivas o por un guión (`-`) si se trata de un rango de líneas—.
18+
- Para resaltar palabras o cadenas dentro de un boque de código, encierra las mismas dentro de dos símbolos `/`.
19+
- Al igual que con los números de línea, en el libro original no se incluyen resalto de líneas o palabras dentro de los bloques de código, por lo que por preferencia personal, he decidido agregarlo a los bloques de código. Muchos de los artículos por traducir no contienen esto agregado, por lo que agradezco que al traducir una página resalten cualquier línea o palabra clave que brinde mayor contexto visual de lo que se transmite en un bloque de código.
20+
21+
Por ejemplo, Nextra renderizará el bloque de código a continuación de manera que tenga números de línea visibles, tenga las líneas 1 y 3 resaltadas, al igual que el rango de líneas de 11 a 13. Así mismo, resaltará las palabras `let`, `var`, y la cadena `: Double`.
22+
23+
```swift showLineNumbers {1, 3, 11-13} /let/ /var/ /: Double/
24+
var unaVariable = 1
25+
26+
let unaConstante = 2
27+
28+
print(unaVariable)
29+
print(unaConstante)
30+
31+
unaVariable = 2
32+
var otraVariable: Double = 3
33+
34+
print(unaVariable)
35+
print(otraVariable)
36+
print(unaVariable + unaConstante)
37+
```
38+
39+
### Texto en bloques de código
1340

1441
He decidido traducir los _strings_, comentarios, y nombres de funciones y variables para brindar mayor entendimiento y contexto en los ejemplos usados en los bloques de código. ¡Ten cuidado de no traducir nombres que hagan referencia a código (variables, clases, etc)!
1542

1643
Ejemplo:
1744

18-
```swift
45+
```swift showLineNumbers
1946
// Example
2047
let apples = 3
2148
let oranges = 5
@@ -27,7 +54,7 @@ print(fruitSummary)
2754

2855
✅ CORRECTO:
2956

30-
```swift
57+
```swift showLineNumbers
3158
// Ejemplo
3259
let manzanas = 3
3360
let naranjas = 5
@@ -39,7 +66,7 @@ print(totalFrutas)
3966

4067
❌ INCORRECTO:
4168

42-
```swift
69+
```swift showLineNumbers
4370
// Ejemplo
4471
let manzanas = 3
4572
let naranjas = 5
@@ -50,41 +77,6 @@ let totalFrutas = "Tengo \(manzanas + naranjas) frutas."
5077
imprimir(totalFrutas)
5178
```
5279

53-
### Bloques de código
54-
55-
Los bloques de código se representan con la siguiente sintaxis:
56-
57-
```swift showLineNumbers
58-
let manzanas = 3
59-
let naranjas = 5
60-
let resumenManzanas = "Tengo \(manzanas) manzanas."
61-
let resumenFrutas = "Tengo \(manzanas + naranjas) frutas."
62-
```
63-
64-
Puedes resaltar líneas específicas de un bloque de código usando la siguiente sintaxis:
65-
66-
```swift showLineNumbers {2, 4}
67-
let manzanas = 3
68-
let naranjas = 5
69-
let resumenManzanas = "Tengo \(manzanas) manzanas."
70-
let resumenFrutas = "Tengo \(manzanas + naranjas) frutas."
71-
```
72-
73-
En el ejemplo anterior, se resaltan las líneas 2 y 4.
74-
75-
También puedes resaltar palabras o términos específicos de un bloque de código usando la siguiente sintaxis:
76-
77-
```swift showLineNumbers {2, 4} /let/
78-
let manzanas = 3
79-
let naranjas = 5
80-
let resumenManzanas = "Tengo \(manzanas) manzanas."
81-
let resumenFrutas = "Tengo \(manzanas + naranjas) frutas."
82-
```
83-
84-
En el ejemplo anterior, se resaltan las líneas 2 y 4, y la palabra `let`.
85-
86-
Algunos bloques de código pueden contener saltos de línea que no están el documento original. Esto, con el fin de brindar una mejor legibilidad de los ejemplos y bloques de código.
87-
8880
<br />
8981

9082
## Usted, tú y vos
@@ -118,6 +110,7 @@ Aquí hay algunas sugerencias para la traducción de términos de uso común en
118110
| loop | ciclo |
119111
| lowercase | minúscula(s) |
120112
| optional binding | vinculación opcional |
113+
| overriding | sustitución |
121114
| render | renderizar (verb), renderizado (noun) |
122115
| scope (noun) | ámbito |
123116
| scope (verb) | aislar |

0 commit comments

Comments
 (0)