Skip to content

Commit 5715ca7

Browse files
committed
docs: translated contributing/pull-requests into ja
1 parent 24146bd commit 5715ca7

File tree

2 files changed

+592
-0
lines changed

2 files changed

+592
-0
lines changed
+110
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
---
2+
title: Pull request checks
3+
description: Learn how to make your pull request successfully pass all checks
4+
weight: 40
5+
cSpell:ignore: REFCACHE
6+
default_lang_commit: 24146bd1368e4c6082c7d6077efd29dba0d51055
7+
---
8+
9+
When you raise a
10+
[pull request](https://docs.github.com/en/get-started/learning-about-github/github-glossary#pull-request)
11+
(PR) with the
12+
[opentelemetry.io repository](https://github.com/open-telemetry/opentelemetry.io)
13+
a set of checks are executed. The PR checks verify that...
14+
15+
- … you have signed the [CLA](#easy-cla).
16+
- …your commit can be deployed through [Netlify](#netlify-deployment)
17+
successfully.
18+
- … your changes are compliant with our [style guide](#style-checks).
19+
20+
{{% alert title="Note" color="primary" %}}
21+
22+
If any of the PR checks fails, try to
23+
[fix content issues automatically](../pull-requests/#内容の問題を自動的に修正する)
24+
first by running `npm run fix:all` on your machine.
25+
26+
Additionally, you can comment `/fix:all` on your Pull Request. This will make
27+
the OpenTelemetry Bot run those commands on your behalf and update the PR. Make
28+
sure that you pull those changes locally.
29+
30+
Only if your issues persist, read below what the different checks do and how you
31+
can recover from a failed state.
32+
33+
{{% /alert %}}
34+
35+
## Easy CLA
36+
37+
This check fails if you haven't [signed the CLA](../prerequisites/#cla).
38+
39+
## Netlify deployment
40+
41+
If the [Netlify](https://www.netlify.com/) build fails, select **Details** for
42+
more information.
43+
44+
## Style checks
45+
46+
To make sure that contributions follow our [style guide](../style-guide/) we
47+
have implemented a set of checks that verify style guide rules and fail l if
48+
they find any issues.
49+
50+
The following list describes current checks and what you can do to fix related
51+
errors:
52+
53+
### TEXT linter
54+
55+
This check verifies that
56+
[OpenTelemetry-specific terms and words are used consistently across the site](../style-guide/#opentelemetryio-word-list).
57+
58+
If any issues are found, annotations are added to your files in the
59+
`files changed` view of your PR. Fix those to turn the check green. As an
60+
alternative, you can run `npm run check:text -- --fix` locally to fix most
61+
issues. Run `npm run check:text` again and manually fix the remaining issues.
62+
63+
### MARKDOWN linter
64+
65+
This check verifies that
66+
[standards and consistency for Markdown files are enforced](../style-guide/#markdown-standards).
67+
68+
If any issues are found, run `npm:run format` to fix most issues. For more
69+
complex issues, run `npm run check:markdown` and apply the suggested changes.
70+
71+
### SPELLING check
72+
73+
This check verifies that
74+
[all words are spelled correctly](../style-guide/#spell-checking).
75+
76+
### CSPELL:IGNORE check
77+
78+
This check will verify that all words in your cSpell ignore list are normalized.
79+
80+
If this check fails, run `npm run fix:dict` locally and push the changes in a
81+
new commit.
82+
83+
### FILENAME check
84+
85+
This check verifies that all
86+
[files are formatted by prettier](../style-guide/#file-format).
87+
88+
If this check fails, run `npm fix:format` locally and push the changes in a new
89+
commit.
90+
91+
### FILE FORMAT
92+
93+
This check verifies that all
94+
[file names are in kebab-case](../style-guide/#file-names).
95+
96+
If this check fails, run `npm fix:filenames` locally and push the changes in a
97+
new commit.
98+
99+
### BUILD and CHECK LINKS / REFCACHE updates?
100+
101+
This check verifies that all links that your commits are introducing are
102+
functional.
103+
104+
Run `npm run check:links` to check them locally. This also updates the reference
105+
cache, or `REFCACHE`. Push any changes to the `REFCACHE` in a new commit.
106+
107+
### WARNINGS in build log?
108+
109+
If this check fails, review the build log for any other potential issues. Ask
110+
maintainers for help, if you are unsure how to recover.

0 commit comments

Comments
 (0)