Fixed some spelling mistakes an typos. (#20590)
Pasé también Pull requests a la forma masculina (La PR > El PR).
This commit is contained in:
Santiago
Jaka Kranjc
@ -11,22 +11,23 @@
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
# Cómo trabajar en artículo de la Guía
|
||||
# Cómo trabajar en artículos de la Guía
|
||||
|
||||
Con tu yuda, podemos crear un herramienta de referencia accesible que ayudará a millones de personas que están aprendiendo a programar en los próximos años. 💛
|
||||
Con tu ayuda, podemos crear un herramienta de referencia accesible que ayudará a millones de personas que están aprendiendo a programar ahora y en los años por venir. 💛
|
||||
|
||||
Puedes:
|
||||
|
||||
|
||||
- [Ayudarnos creando y editando articulos de la Guía](#steps-for-creating-and-editing-guide-articles).
|
||||
- [Ayudarnos a revisar Pull Requests para artículos de la guía]()
|
||||
- [Ayudarnos revisando Pull Requests para artículos de la Guía]()
|
||||
|
||||
## Pasos para crear y editar artículos de la Guía
|
||||
|
||||
1. 🍴 [Fork este repositorio](https://github.com/freeCodeCamp/freeCodeCamp#fork-destination-box)
|
||||
2. 👀️ Sigue las normas de contribución expuestas a continuación.
|
||||
3. 🔧 Propóne cambios asombrosos!
|
||||
3. 🔧 Haz cambios asombrosos!
|
||||
4. 📖 Lee la [guía de buenas prácticas de estilo](/docs/style-guide-for-guide-articles).
|
||||
5. 👉 [Hace un Pull Request](https://github.com/freeCodeCamp/freeCodeCamp/compare)
|
||||
5. 👉 [Haz un Pull Request](https://github.com/freeCodeCamp/freeCodeCamp/compare)
|
||||
6. 🎉 Consigue que aprueben tu Pull request - Éxito!
|
||||
|
||||
O simplemente [crea un tema](https://github.com/freeCodeCamp/freeCodeCamp/issues) - toda pequeña ayuda cuenta! 😊
|
||||
@ -48,7 +49,8 @@ Mira este vídeo de demostración o sigue los siguientes pasos:
|
||||
|
||||
|
||||
|
||||
1. Ve a las carpetas **"páginas"** (situado en [`guide`](/guide)) donde encontrarás el artículo raiz que quieras editar.
|
||||
|
||||
1. Ve a la carpeta **"páginas"** (situado en [`guide`](/guide)) donde encontrarás el artículo raiz que quieras editar.
|
||||
|
||||
> Todas las raíces estarán en un archivo index.md
|
||||
|
||||
@ -58,26 +60,27 @@ Mira este vídeo de demostración o sigue los siguientes pasos:
|
||||
|
||||
3. Desplázate a la parte de abajo de la pantalla y añade un mensaje explicando tus cambios.
|
||||
|
||||
(Opcional): Recomendamos haer un mensaje convencional. Esta es una buena práctica que verás en algunos de los repositorios Open Source más populares. Como desarrollador, deberías seguir las prácticas estándar.
|
||||
(Opcional): Recomendamos hacer un mensaje convencional. Esta es una buena práctica que verás en algunos de los repositorios Open Source más populares. Como desarrollador, deberías seguir las prácticas estándar.
|
||||
|
||||
Algunos ejemplos de mensajes convencionales serían:
|
||||
|
||||
```md
|
||||
Solución: Actualizar articúlo de guía sobre HTML
|
||||
Solución: Actualizar scripts para Travis-CI
|
||||
fix: Actualizar artículo de guía sobre HTML
|
||||
fix: Actualizar scripts para Travis-CI
|
||||
feat: Añadir articulo sobre JavaScript hoisting
|
||||
Documentos: Actualizadas recomendaciones de contribución
|
||||
docs: Actualizadas recomendaciones de contribución
|
||||
```
|
||||
|
||||
Sea breve, no más de 50 caracteres. Puedes añadir información extra en la descripción del mensaje.
|
||||
|
||||
Se breve, no más de 50 caracteres. Puedes añadir información adicional en la descripción del mensaje.
|
||||
|
||||
esto no supone ningún esfuerzo adicional respecto a mensajes como 'update file' o 'add index.md'
|
||||
|
||||
Puedes aprender más sobre [por qué deberías seguir esta práctica aquí](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits).
|
||||
|
||||
4. Selecciona el botón con la opción **"Crear una nueva rama para esta propuesta y enviar"** and click <kbd>Proponer cambio en el archivo</kbd>.
|
||||
4. Selecciona el botón con la opción **"Crear una nueva rama para esta propuesta y enviar"** y click en <kbd>Proponer cambio en el archivo</kbd>.
|
||||
|
||||
5. En la siguiente pantalla, puedes añadir más detalles sobre tu PR, luego pincha en <kbd>Crear pull request</kbd>.
|
||||
5. En la siguiente pantalla, puedes añadir más detalles sobre tu PR, luego click en <kbd>Crear pull request</kbd>.
|
||||
|
||||
Felicidades 🎉! Acabas de crear un pull request.
|
||||
|
||||
@ -85,24 +88,25 @@ Felicidades 🎉! Acabas de crear un pull request.
|
||||
|
||||
No es obligatorio que trabajes en tu sistema personal, salvo que desees pre-visualizar tus cambios, o trabajar con version actualizada y arreglos de UI. También es recomendable si tienes problemas con git como errores de integración, rebase, etc.
|
||||
|
||||
##### Lee sobre estas recomendaciones en [Cómo configurar freeCodeCamp localmente](/docs/how-to-setup-freecodecamp-locally.md)
|
||||
##### Lee las recomendaciones en [Cómo configurar freeCodeCamp localmente](/docs/how-to-setup-freecodecamp-locally.md)
|
||||
|
||||
### Aceptación de la PR
|
||||
### Aceptación del PR
|
||||
|
||||
Estos son algunos criterios utilizados por los criticos cuando evalúan PRs:
|
||||
|
||||
- Descripción y título relevantes
|
||||
- La PR respeta la [guía de estilo](/docs/style-guide-for-guide-articles)
|
||||
- El PR respeta la [guía de estilo](/docs/style-guide-for-guide-articles)
|
||||
- Consejos generales de QA de las [recomendaciones para Moderadores](https://forum.freecodecamp.org/t/freecodecamp-moderator-guidelines/18295)
|
||||
- Siempre y cuando el PR suponga una mejora o ampliación de la guía, será aceptado aunque tenga errores gramaticos o contenido parcial
|
||||
- Las PR más antiguas se revisan primero
|
||||
- Siempre y cuando el PR suponga una mejora o ampliación de la guía, será aceptado aunque tenga errores gramaticales o contenido parcial
|
||||
- Los PR más antiguos se revisan primero
|
||||
|
||||
|
||||
#### Etiquetas
|
||||
|
||||
- **contenido** es para Pull Requests que modifican el contenido de artículos en la guía (añaden un nuevo artículo o actualizan uno existente)
|
||||
- **duplicada** es para Pull Request que contienen el mismo contenido que otro PR abierto
|
||||
- **duplicado** es para Pull Request que contienen el mismo contenido que otro PR abierto
|
||||
- **cambios solicitados** es para Pull Requests que necesitan algún cambio antes de ser integrados
|
||||
- **pasada** es para Pull Requests que con etiqueta _"changes requested"_ que no han tenido actividad durante al menos 2 semanas y serán por tanto cerrados
|
||||
- **pasado** es para Pull Requests que con etiqueta _"changes requested"_ que no han tenido actividad durante al menos 2 semanas y serán por tanto cerrados
|
||||
- Un pull request _pasado_ debe cerrarse.
|
||||
- Este es [un ejemplo](https://github.com/freeCodeCamp/freeCodeCamp/pull/235).
|
||||
|
||||
@ -125,14 +129,17 @@ Los revisores harán todos los esfuerzos posibles para resolver estos conflictos
|
||||
Si el Pull Request no es perfecto el revisor podría:
|
||||
|
||||
- solicitar cambios al contribuidor y añadir la etiqueta *cambios solicitados*
|
||||
- solucionar errores menores y hacer un envío encima de el PR
|
||||
- solucionar errores menores y hacer un envío encima del PR
|
||||
|
||||
|
||||
#### Travis CI Build
|
||||
|
||||
Todos los PRs deben superar los test de Travis CI antes de poder ser integrados.
|
||||
|
||||
|
||||
Si un PR rompe la ejecución (un test de Travis CI falla y muestra una "X" roja) hay tres causas probables y tendrás que resolver el problema antes de que podamos integrar el PR:
|
||||
|
||||
|
||||
1. Tu PR crea un nuevo artículo pero le falta un archivo `index.md` en algún lugar.
|
||||
- Cada directorio en `src/pages` necesita un archivo `index.md` en él (y debe llamarse `index.md`).
|
||||
- Dos escenarios muy probables son
|
||||
@ -147,14 +154,14 @@ Si un PR rompe la ejecución (un test de Travis CI falla y muestra una "X" roja)
|
||||
|
||||
Cerramos Pull Requests
|
||||
|
||||
- Si una PR más antigua para el mismo artículo es integrada, y tu PR no añade nuevo contenido
|
||||
- Si un PR más antiguo para el mismo artículo es integrado, y tu PR no añade nuevo contenido
|
||||
- Si hay poco o ningún esfuerzo por tu parte en su elaboración (Por ejemplo: copias literales de artículos de páginas como Wikipedia)
|
||||
- Si incluye contenido copiado de fuentes con Copyright - ver [Citas](https://github.com/freeCodeCamp/freeCodeCamp/issues/2503)
|
||||
- Si no respeta la [Guía de estilo para escribir articulos](/docs/style-guide-for-guide-articles.md)
|
||||
- Si no respeta la [Política Académica de Honestidad](https://www.freecodecamp.org/academic-honesty)
|
||||
- Si está pasada (un cambio ha sido solicitado y no ha habiado respuesta en 2 semanas)
|
||||
- Si está estancado (un cambio ha sido solicitado y no ha habiado respuesta en 2 semanas)
|
||||
|
||||
Además, si estás trabajando a partir de un artículo raiz, tus cambios deben ser los suficiente notables como para sustituir al original.
|
||||
Además, si estás trabajando a partir de un artículo raiz, tus cambios deben ser lo suficientemente notables como para sustituir al original.
|
||||
|
||||
No aceptaremos PRs que solamente incluyan links a la sección de "Más información:".
|
||||
|
||||
@ -178,17 +185,17 @@ Mantente activo en el [chat de Contribuidores](https://gitter.im/freecodecamp/co
|
||||
|
||||
## Aplastar e integrar
|
||||
|
||||
Utilizamos la opción <kcd>Aplastar e integrar</kcd> al integrar una PR para mentener el historial de propuestas limpio.
|
||||
Utilizamos la opción <kcd>Aplastar e integrar</kcd> al integrar un PR para mantener el historial de propuestas limpio.
|
||||
|
||||
|
||||
|
||||
### Filtrar PRs
|
||||
|
||||
> PR, Obierta, Más Antiguas Primero, Travis CI Build correcta, nadie asignado, sin comentarios
|
||||
> PR, Abierto, Más Antiguos Primero, Travis CI Build correcta, nadie asignado, sin comentarios
|
||||
|
||||
[`is:pr is:open sort:updated-asc status:success no:assignee comments:0`](https://github.com/freeCodeCamp/freeCodeCamp/pulls?utf8=%E2%9C%93&q=is%3Apr%20is%3Aopen%20sort%3Aupdated-asc%20status%3Asuccess%20no%3Aassignee%20comments%3A0)
|
||||
|
||||
> PR, Open, Oldest First, Does not have labels: `platform`, `enhancement`, `invalid` or `changes requested`
|
||||
> PR, Abierto, Más Antiguos Primero, No contiene las etiquetas: `platform`, `enhancement`, `invalid` or `changes requested`
|
||||
|
||||
[`is:pr is:open sort:updated-asc -label:platform -label:enhancement -label:invalid -label:"changes requested"`](https://github.com/freeCodeCamp/freeCodeCamp/pulls?utf8=%E2%9C%93&q=is%3Apr%20is%3Aopen%20sort%3Aupdated-asc%20-label%3Aplatform%20-label%3Aenhancement%20-label%3Ainvalid%20-label%3A%22changes%20requested%22).
|
||||
|
||||
@ -208,10 +215,10 @@ Estamos encantados de aceptar estos cambios y esperamos tus futuras aportaciones
|
||||
> Para agradecer y animar a contribuidores primerizos.
|
||||
|
||||
```markdown
|
||||
Hola @username. Enhorabuena por tu primera pull request (PR)! 🎉
|
||||
Hola @username. Enhorabuena por tu primer pull request (PR)! 🎉
|
||||
|
||||
Gracias por contribuir a la página! 👍
|
||||
Estamos encantados de aceptar estos cambios y esperamos tus futuras aportaciones. 📝
|
||||
Estamos encantados de aceptar estos cambios y esperamos tus futuros aportes. 📝
|
||||
```
|
||||
|
||||
#### Error de intregración
|
||||
@ -227,17 +234,17 @@ Una vez resuelvas el problema, podré revisar tu PR e integrarla. 😊
|
||||
|
||||
> Puedes conseguir más información en la [Guía de estilo para escibir Artículos](https://github.com/freeCodeCamp/freeCodeCamp#article-title) sobre cómo formatear tus artículos para que superen los test de Travis CI. ✅
|
||||
>
|
||||
> Además, es una buena ráctica en GitHub escribir una decripción breve de tus cambios al crear una PR. 📝
|
||||
> Además, es una buena práctica en GitHub escribir una decripción breve de tus cambios al crear un PR. 📝
|
||||
```
|
||||
|
||||
#### Sincronización de Fork
|
||||
|
||||
> Cuando la PR no está actualizada con la rama `master`.
|
||||
> Cuando el PR no está actualizada con la rama `master`.
|
||||
|
||||
``````markdown
|
||||
Hola @username
|
||||
|
||||
Me enctaría poder integrar tus cambios pero parece que hay un error con los test de Travis CI build. ⚠️
|
||||
Me encantaría poder integrar tus cambios pero parece que hay un error con los test de Travis CI build. ⚠️
|
||||
|
||||
```bash
|
||||
Error: ENOTDIR: not a directory, open 'src/pages/java/data-abstraction/index.md'
|
||||
@ -263,40 +270,40 @@ Una vez sincronices tu fork y superes los test podré integrar tu PR. 😊
|
||||
|
||||
---
|
||||
|
||||
> Puedes conseguir más información en e artículo [Sincronizando un Fork](https://help.github.com/articles/syncing-a-fork/) sobre cómo mantener al día tu fork con el repositorio principal. 🔄
|
||||
> Puedes conseguir más información en el artículo [Sincronizando un Fork](https://help.github.com/articles/syncing-a-fork/) sobre cómo mantener al día tu fork con el repositorio principal. 🔄
|
||||
>
|
||||
> Además, es una buena ráctica en GitHub escribir una decripción breve de tus cambios al crear una PR. 📝
|
||||
> Además, es una buena práctica en GitHub escribir una decripción breve de tus cambios al crear un PR. 📝
|
||||
``````
|
||||
|
||||
#### Conflictos de integración
|
||||
|
||||
> Cuando la PR tiene conflictos de integración que debemos resolver.¹
|
||||
> Cuando el PR tiene conflictos de integración que debemos resolver.¹
|
||||
|
||||
```markdown
|
||||
Hola @username
|
||||
|
||||
Me encantaría poder integrar tus cambios para parece que tienes conflictos de integración. ⚠️
|
||||
|
||||
Una vez resuelvas estos conflictos, podré revisar tu PR e integrarla. 😊
|
||||
Una vez resuelvas estos conflictos, podré revisar tu PR e integrarlo. 😊
|
||||
|
||||
---
|
||||
|
||||
> Si no estás familiarizado con los conflictos de integración, por favor revisa la guía de GitHub ["Resolviendo conflictos de integración"](https://help.github.com/articles/resolving-a-merge-conflict-on-github/) para más información. 🔍️
|
||||
>
|
||||
> Además, es una buena ráctica en GitHub escribir una decripción breve de tus cambios al crear una PR. 📝
|
||||
> Además, es una buena práctica en GitHub escribir una decripción breve de tus cambios al crear un PR. 📝
|
||||
```
|
||||
¹ Si un contribuidor primerizo tiene conflictos de integración, los encargados de mantenimiento lo resolverán en su lugar.
|
||||
|
||||
#### Duplicado
|
||||
|
||||
> Cuando la PR está duplicada o es repetitiva
|
||||
> Cuando el PR está duplicado o es repetitivo
|
||||
|
||||
```markdown
|
||||
Hola @username
|
||||
|
||||
Parece que ya se han aceptado cambios similares para este artículo que estás editando, lo siento. 😓
|
||||
|
||||
Si cees que tienes más que aportar, por favor abre una nueva PR.
|
||||
Si cees que tienes más que aportar, por favor abre un nuevo PR.
|
||||
|
||||
Gracias de nuevo! 😊
|
||||
|
||||
@ -305,14 +312,14 @@ Gracias de nuevo! 😊
|
||||
> Si tienes preguntas, no dudes en contactarnos a través [Gitter](https://gitter.im/FreeCodeCamp/Contributors) o comentando más abajo. 💬
|
||||
```
|
||||
|
||||
#### Cerrando Pull Requests no válidas
|
||||
#### Cerrando Pull Requests no válidos
|
||||
|
||||
> Cuando una PR no es válida.
|
||||
> Cuando un PR no es válido.
|
||||
|
||||
```markdown
|
||||
Hola @username
|
||||
|
||||
No has añadido ningún contenido real por invalidaré esta PR y la etiquetaré como `inválida`. 😓️
|
||||
No has añadido ningún contenido real por lo que invalidaré este PR y lo etiquetaré como `inválido`. 😓️
|
||||
|
||||
En cualquier caso, no dudes en abrir otras PR! 👍
|
||||
En cualquier caso, no dudes en abrir otros PR! 👍
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user