-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6e16f18
commit db24032
Showing
4 changed files
with
61 additions
and
59 deletions.
There are no files selected for viewing
57 changes: 2 additions & 55 deletions
57
...docs/contributing/issues-announcements.md → ...ent/en/docs/contributing/announcements.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
title: Reporting an issue | ||
description: How to report a bug, a security issue, or a potential improvement. | ||
weight: 50 | ||
--- | ||
|
||
If you notice an error or want to suggest improvements to existing content, open | ||
an issue. | ||
|
||
1. Click the **Create documentation issue** link on any document. This redirects | ||
you to a GitHub issue page prepopulated with some headers. | ||
2. Describe the issue or suggestion for improvement. Provide as many details as | ||
you can. | ||
3. Click **Submit new issue**. | ||
|
||
After submitting, check in on your issue occasionally or turn on GitHub | ||
notifications. It might take a few days until maintainers and approvers respond. | ||
Reviewers and other community members might ask questions before they can take | ||
action on your issue. | ||
|
||
## Suggesting new content or features | ||
|
||
If you have an idea for new content or a feature, but you aren't sure where it | ||
should go, you can still file an issue. You can also report bugs and security | ||
vulnerabilities. | ||
|
||
1. Go to | ||
[GitHub](https://github.com/open-telemetry/opentelemetry.io/issues/new/) and | ||
select **New issue** inside the **Issues** tab. | ||
|
||
1. Select the type of issue that best applies to your request or doubt. | ||
|
||
1. Fill out the template. | ||
|
||
1. Submit the issue. | ||
|
||
### How to file great issues | ||
|
||
Keep the following in mind when filing an issue: | ||
|
||
- Provide a clear issue description. Describe what specifically is missing, out | ||
of date, wrong, or needs improvement. | ||
- Explain the specific impact the issue has on users. | ||
- Limit the scope of a given issue to a reasonable unit of work. For problems | ||
with a large scope, break them down into smaller issues. For example, "Fix the | ||
security docs" is too broad, but "Add details to the 'Restricting network | ||
access' topic" is specific enough to be actionable. | ||
- Search the existing issues to see if there's anything related or similar to | ||
the new issue. | ||
- If the new issue relates to another issue or pull request, refer to it either | ||
by its full URL or by the issue or pull request number prefixed with a `#` | ||
character. For example, `Introduced by #987654`. | ||
- Follow the | ||
[Code of Conduct](https://github.com/open-telemetry/community/blob/main/code-of-conduct.md). | ||
Respect your fellow contributors. For example, "The docs are terrible" is not | ||
helpful or polite feedback. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters