Skip to content

Commit 719c6f1

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

File tree

1 file changed

+102
-0
lines changed

1 file changed

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

0 commit comments

Comments
 (0)