2
2
title : Pull request checks
3
3
description : Learn how to make your pull request successfully pass all checks
4
4
weight : 40
5
- cSpell:ignore : REFCACHE
6
5
---
7
6
8
7
When you raise a
@@ -31,7 +30,7 @@ can recover from a failed state.
31
30
32
31
{{% /alert %}}
33
32
34
- ## Easy CLA
33
+ ## ` Easy CLA ` {.notranslate lang=en}
35
34
36
35
This check fails if you haven't [ signed the CLA] ( ../prerequisites/#cla ) .
37
36
@@ -49,7 +48,7 @@ find any issues.
49
48
The following list describes current checks and what you can do to fix related
50
49
errors:
51
50
52
- ### TEXT linter
51
+ ### ` TEXT linter ` {.notranslate lang=en}
53
52
54
53
This check verifies that
55
54
[ OpenTelemetry-specific terms and words are used consistently across the site] ( ../style-guide/#opentelemetryio-word-list ) .
@@ -59,51 +58,51 @@ If any issues are found, annotations are added to your files in the
59
58
alternative, you can run ` npm run check:text -- --fix ` locally to fix most
60
59
issues. Run ` npm run check:text ` again and manually fix the remaining issues.
61
60
62
- ### MARKDOWN linter
61
+ ### ` MARKDOWN linter ` {.notranslate lang=en}
63
62
64
63
This check verifies that
65
64
[ standards and consistency for Markdown files are enforced] ( ../style-guide/#markdown-standards ) .
66
65
67
66
If any issues are found, run ` npm run:format ` to fix most issues. For more
68
67
complex issues, run ` npm run check:markdown ` and apply the suggested changes.
69
68
70
- ### SPELLING check
69
+ ### ` SPELLING check ` {.notranslate lang=en}
71
70
72
71
This check verifies that
73
72
[ all words are spelled correctly] ( ../style-guide/#spell-checking ) .
74
73
75
- ### CSPELL: IGNORE check
74
+ ### ` CSPELL ` check {.notranslate lang=en}
76
75
77
76
This check will verify that all words in your cSpell ignore list are normalized.
78
77
79
78
If this check fails, run ` npm run fix:dict ` locally and push the changes in a
80
79
new commit.
81
80
82
- ### FILENAME check
81
+ ### ` FILENAME check ` {.notranslate lang=en}
83
82
84
83
This check verifies that all
85
84
[ files are formatted by prettier] ( ../style-guide/#file-format ) .
86
85
87
86
If this check fails, run ` npm fix:format ` locally and push the changes in a new
88
87
commit.
89
88
90
- ### FILE FORMAT
89
+ ### ` FILE FORMAT ` {.notranslate lang=en}
91
90
92
91
This check verifies that all
93
92
[ file names are in kebab-case] ( ../style-guide/#file-names ) .
94
93
95
94
If this check fails, run ` npm fix:filenames ` locally and push the changes in a
96
95
new commit.
97
96
98
- ### BUILD and CHECK LINKS / REFCACHE updates?
97
+ ### ` BUILD and CHECK LINKS ` {.notranslate lang=en}
99
98
100
- This check verifies that all links that your commits are introducing are
101
- functional.
99
+ This check builds the website and verifies that all links are valid.
102
100
103
- Run ` npm run check:links ` to check them locally . This also updates the reference
104
- cache, or ` REFCACHE ` . Push any changes to the ` REFCACHE ` in a new commit.
101
+ To check links locally, run ` npm run check:links ` . This command also updates the
102
+ reference cache . Push any changes to the refcache in a new commit.
105
103
106
- ### WARNINGS in build log?
104
+ ### ` WARNINGS in build log? ` {.notranslate lang=en}
107
105
108
- If this check fails, review the build log for any other potential issues. Ask
109
- maintainers for help, if you are unsure how to recover.
106
+ If this check fails, review the ` BUILD and CHECK LINKS ` log, under the
107
+ ` npm run log:check:links ` step, for any other potential issues. Ask maintainers
108
+ for help, if you are unsure how to recover.
0 commit comments