Skip to content

Commit 15ff65e

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

File tree

1 file changed

+101
-0
lines changed

1 file changed

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

0 commit comments

Comments
 (0)