Skip to content

Commit 2a19dd2

Browse files
committed
docs: translated contributing/issues into ja
1 parent 01d3e2e commit 2a19dd2

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed
+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: Issues
3+
description:
4+
How to fix an existing issue, or report a bug, security risk, or potential
5+
improvement.
6+
weight: 10
7+
_issues: https://github.com/open-telemetry/opentelemetry.io/issues
8+
_issue: https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A
9+
default_lang_commit: 01d3e2eee9798dfa7c4a36425621849a2a37e489
10+
cSpell:ignore: prepopulated
11+
---
12+
13+
## Fixing an existing issue
14+
15+
One of the best ways to help make OTel docs better is to fix an existing issue.
16+
17+
1. Browse through the list of [issues]({{% param _issues %}}).
18+
2. Select an issue that you would like to work on, ideally one that you can fix
19+
in a short amount of time.
20+
21+
<!-- prettier-ignore -->
22+
<a name="first-issue"></a>
23+
{{% alert title="First time contributing? " %}}
24+
25+
Select an issue with the following labels:
26+
27+
- [Good first issue]
28+
- [Help wanted]
29+
30+
<!-- prettier-ignore -->
31+
> **NOTE**: we **_do not_ assign issues** to those who
32+
> have not already made contributions to the [OpenTelemetry
33+
> organization][org], unless part of a mentorship or onboarding
34+
> process.
35+
{.mt-3}
36+
37+
<!-- prettier-ignore -->
38+
[good first issue]: {{% param _issue %}}%22good+first+issue%22
39+
[help wanted]: {{% param _issue %}}%3A%22help+wanted%22
40+
[org]: https://github.com/open-telemetry
41+
42+
{{% /alert %}}
43+
44+
3. Read through the issue comments, if any.
45+
4. Ask maintainers if this issue is still relevant, and ask any questions you
46+
need for clarification by posting comments over the issue.
47+
5. Share your intention to work on the issue by adding add a comment to this
48+
effect.
49+
6. Work on fixing the issue. Let maintainers know if you run into any problems.
50+
7. When ready, [submit your work through a pull request](../pull-requests) (PR).
51+
52+
## Reporting an issue
53+
54+
If you notice an error or want to suggest improvements to existing content, open
55+
an issue.
56+
57+
1. Click the **Create documentation issue** link on any document. This redirects
58+
you to a GitHub issue page prepopulated with some headers.
59+
2. Describe the issue or suggestion for improvement. Provide as many details as
60+
you can.
61+
3. Click **Submit new issue**.
62+
63+
After submitting, check in on your issue occasionally or turn on GitHub
64+
notifications. It might take a few days until maintainers and approvers respond.
65+
Reviewers and other community members might ask questions before they can take
66+
action on your issue.
67+
68+
## Suggesting new content or features
69+
70+
If you have an idea for new content or a feature, but you aren't sure where it
71+
should go, you can still file an issue. You can also report bugs and security
72+
vulnerabilities.
73+
74+
1. Go to
75+
[GitHub](https://github.com/open-telemetry/opentelemetry.io/issues/new/) and
76+
select **New issue** inside the **Issues** tab.
77+
78+
1. Select the type of issue that best applies to your request or doubt.
79+
80+
1. Fill out the template.
81+
82+
1. Submit the issue.
83+
84+
### How to file great issues
85+
86+
Keep the following in mind when filing an issue:
87+
88+
- Provide a clear issue description. Describe what specifically is missing, out
89+
of date, wrong, or needs improvement.
90+
- Explain the specific impact the issue has on users.
91+
- Limit the scope of a given issue to a reasonable unit of work. For problems
92+
with a large scope, break them down into smaller issues. For example, "Fix the
93+
security docs" is too broad, but "Add details to the 'Restricting network
94+
access' topic" is specific enough to be actionable.
95+
- Search the existing issues to see if there's anything related or similar to
96+
the new issue.
97+
- If the new issue relates to another issue or pull request, refer to it either
98+
by its full URL or by the issue or pull request number prefixed with a `#`
99+
character. For example, `Introduced by #987654`.
100+
- Follow the
101+
[Code of Conduct](https://github.com/open-telemetry/community/blob/main/code-of-conduct.md).
102+
Respect your fellow contributors. For example, "The docs are terrible" is not
103+
helpful or polite feedback.

0 commit comments

Comments
 (0)