Skip to content

Commit 3b62469

Browse files
didiVikingopentelemetrybottheletterf
authored
feat: [es] Create docs/contributing/pr-checks.md (#6371)
Signed-off-by: Diana Todea <[email protected]> Co-authored-by: opentelemetrybot <[email protected]> Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
1 parent ab679dd commit 3b62469

File tree

1 file changed

+151
-0
lines changed

1 file changed

+151
-0
lines changed
Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
---
2+
title: Comprobaciones para PR
3+
description:
4+
Aprenda cómo hacer que su PR pase con éxito todas las comprobaciones
5+
weight: 40
6+
default_lang_commit: 565307515b288bf5e8bee88d73ff4fac1fd93d5e
7+
cSpell:ignore: REFCACHE
8+
---
9+
10+
Cuando creas un
11+
[pull request](https://docs.github.com/en/get-started/learning-about-github/github-glossary#pull-request)
12+
(PR) con
13+
[repositorio opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io)
14+
se ejecutan una serie de comprobaciones. Las comprobaciones PR verifican que:
15+
16+
- Has firmado el [CLA](#easy-cla).
17+
- Su confirmación se puede implementar a través de
18+
[Netlify](#netlify-deployment) exitosamente.
19+
- Sus cambios cumplen con nuestra [guía de estilo](#style-checks).
20+
21+
{{% alert title="Note" color="primary" %}}
22+
23+
Si alguna de las comprobaciones del pull request fallan, intenta ante todo
24+
[solucionar automáticamente problemas de contenido](../pull-requests/#fix-issues)
25+
ejecutando `npm run fix:all` en tu máquina.
26+
27+
Además, puedes comentar `/fix:all` en tus PRs. Esto hará que el bot
28+
OpenTelemetry ejecute esos comandos en su nombre y actualice la solicitud de
29+
incorporación de cambios. Asegúrate de extraer esos cambios localmente.
30+
31+
Si los problemas persisten, lee a continuación qué hacen las diferentes
32+
comprobaciones y cómo puede recuperarse un estado fallido.
33+
34+
{{% /alert %}}
35+
36+
## Easy CLA {#easy-cla}
37+
38+
Esta comprobación falla si no has [firmado el CLA](../prerequisites/#cla).
39+
40+
## Despliega Netlify {#netlify-deployment}
41+
42+
Si la compilación [Netlify](https://www.netlify.com/) falla, selecciona
43+
**Details** para mas información.
44+
45+
## Comprobaciones de estilo {#style-checks}
46+
47+
Para asegurarnos de que las contribuciones sigan nuestra
48+
[guía de estilo](../style-guide/) hemos implementado un conjunto de
49+
comprobaciones que verifican las reglas de la guía de estilo y fallan si
50+
encuentran algún problema.
51+
52+
La siguiente lista describe las comprobaciones actuales y lo que puedes hacer
53+
para corregir errores relacionados:
54+
55+
### `TEXT linter` {.notranslate lang=en}
56+
57+
Esta comprobación verifica que
58+
[los términos y palabras específicos de OpenTelemetry se usan de manera uniforme en todo el sitio](../style-guide/#opentelemetryio-word-list).
59+
60+
Si se encuentran problemas, se agregan anotaciones a sus archivos en la vista
61+
`archivos modificados` de su PR. Solucione esos problemas para que la marca de
62+
verificación se vuelva verde. Como alternativa, puede ejecutar
63+
`npm run check:text -- --fix` localmente para corregir la mayoría de los
64+
problemas. Ejecute `npm run check:text` nuevamente y corrige manualmente los
65+
problemas restantes.
66+
67+
### `MARKDOWN linter` {.notranslate lang=en}
68+
69+
Esta comprobación verifica que
70+
[se apliquen los estándares y la coherencia para los archivos Markdown](../style-guide/#markdown-standards).
71+
72+
Si se encuentran problemas, ejecuta `npm:run format` para corregir la mayoría de
73+
los problemas. Para problemas más complejos, ejecuta `npm run check:markdown` y
74+
aplique los cambios sugeridos.
75+
76+
### `SPELLING check` {.notranslate lang=en}
77+
78+
Esta verificación comprueba que
79+
[todas las palabras estén escritas correctamente](../style-guide/#spell-checking).
80+
81+
### `CSPELL check` {.notranslate lang=en}
82+
83+
Esta verificación comprobará que todas las palabras en su lista de ignorados de
84+
cSpell estén normalizadas.
85+
86+
Si esta verificación falla, ejecuta `npm run fix:dict` localmente y envíe los
87+
cambios en una nueva confirmación.
88+
89+
### `FILENAME check` {.notranslate lang=en}
90+
91+
Esta verificación comprueba que todos
92+
[los archivos estén formateados por prettier](../style-guide/#file-format).
93+
94+
Si esta verificación falla, ejecuta `npm fix:format` localmente y envía los
95+
cambios en una nueva confirmación.
96+
97+
### `FILE FORMAT` {.notranslate lang=en}
98+
99+
Esta verificación comprueba que todos
100+
[los nombres de archivo estén en mayúsculas y minúsculas](../style-guide/#file-names).
101+
102+
Si esta comprobación falla, ejecute `npm fix:filenames` localmente y envíe los
103+
cambios en una nueva confirmación.
104+
105+
### `BUILD and CHECK LINKS` {.notranslate lang=en}
106+
107+
Esta comprobación verifica que todos los enlaces que sus confirmaciones están
108+
introduciendo sean funcionales.
109+
110+
Ejecuta `npm run check:links` para verificarlos localmente. Esto también
111+
actualiza el caché de referencia, o refcache. Envía cualquier cambio a la
112+
refcache en un nuevo commit.
113+
114+
#### Arreglar 404s
115+
116+
Has de arreglar las URLs reportadas como **no válidas** (estado HTTP **404**),
117+
por el comprobador de enlaces.
118+
119+
#### Tratamiento de enlaces externos válidos
120+
121+
El comprobador de enlaces obtiene a veces un estado HTTP diferente a 200 (éxito)
122+
debido a servidores que bloquean comprobadores. Estos servidores devuelven a
123+
menudo estados HTTP en el rango 400 que no son 404, como 401, 403, o 406, que
124+
son los más comunes. Algunos servidores, como LinkedIn, devuelven un 999.
125+
126+
Si has comprobado manualmente un enlace externo que el comprobador de enlaces no
127+
consigue validar con estado exitoso, añade el siguiente parámetro query a la URL
128+
que quieres que el comprobador de enlaces ignore: `?no-link-check`. Por ejemplo,
129+
<https:/some-example.org?no-link-check> es ignorado por el comprobador de
130+
enlaces.
131+
132+
{{% alert-md title="Maintainers tip" color=info %}}
133+
134+
Los mantenedores pueden ejecutar el siguiente script justo después de haber
135+
ejecutado el comprobador de enlaces para que Puppeteer intente validar enlaces
136+
con estados no exitosos.
137+
138+
```sh
139+
./scripts/double-check-refcache-400s.mjs -f --max-num-to-update 99
140+
```
141+
142+
Este script también valida fragmentos de URL que el comprobador de enlaces no
143+
chequea.
144+
145+
{{% /alert-md %}}
146+
147+
### `WARNINGS in build log?` {.notranslate lang=en}
148+
149+
Si esta comprobación falla, revisa el registro de compilación para ver si hay
150+
otros problemas potenciales. Pide ayuda a los mantenedores si no estás seguro de
151+
cómo solucionarlos.

0 commit comments

Comments
 (0)