Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edits to follow up contribution guidelines work #3846

Merged
merged 7 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,4 @@ content/en/docs/kubernetes/helm/ @open-telemetry/docs-approvers @open-te
content/en/docs/specs/ @open-telemetry/docs-approvers @open-telemetry/specs-approvers
content/en/docs/security/ @open-telemetry/docs-approvers @open-telemetry/sig-security-maintainers
content/en/ecosystem/demo/ @open-telemetry/demo-approvers @open-telemetry/demo-approvers
content/en/docs/contributing/ @open-telemetry/docs-approvers @open-telemetry/docs-maintainers
25 changes: 16 additions & 9 deletions content/en/docs/contributing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ Pull requests are merged when they comply with the following criteria:

> **Important**
>
> Do not worry too much about failing PR checks! Community members will help you
> Do not worry too much about failing PR checks. Community members will help you
> to get them fixed, by either providing you with instructions how to fix them
> or by fixing them on your behave.

Expand Down Expand Up @@ -596,17 +596,19 @@ Keep the following in mind when filing an issue:

## Contribute to other repositories

The OpenTelemetry project contains many repositories. Several of these
repositories contain documentation: user-facing help text, error messages, API
references or code comments.
OpenTelemetry is an open source project, and we gladly accept new contributions
and contributors. See the CONTRIBUTING.md file in each SIG repository for
information on getting started.

Individual SIGs may maintain documentation above and beyond what is offered
here, but we strive for accurate general guidance on using the project from our
main website.

If you see text you'd like to improve, use GitHub to search all repositories in
the OpenTelemetry organization. This can help you figure out where to submit
your issue or PR.

Each repository has its own processes and procedures. Before you file an issue
or submit a PR, read that repository's `README.md`, `CONTRIBUTING.md`, and
`code-of-conduct.md`, if they exist.
your issue or PR. Each repository has its own processes and procedures. Before
you file an issue or submit a PR, read that repository's `README.md`,
`CONTRIBUTING.md`, and `code-of-conduct.md`, if they exist.

Most repositories use issue and PR templates. Have a look through some open
issues and PRs to get a feel for that team's processes. Make sure to fill out
Expand All @@ -621,3 +623,8 @@ the templates with as much detail as possible when you file issues or PRs.
[dashboard]: https://app.netlify.com/sites/opentelemetry/overview
[deploy preview]:
https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/

## Code of conduct

OpenTelemetry follows the
[CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
2 changes: 0 additions & 2 deletions content/en/docs/contributing/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,8 @@ the site.
| OpenTelemetry | OpenTelemetry should always be capitalized. Don't use Open-Telemetry. |
| OTel | OTel is the accepted short form of OpenTelemetry. Don't use OTEL. |
| Collector | When referring to the OpenTelemetry Collector, always capitalize Collector. |
| Repository | Code repository, lowercase when in the middle of a sentence. Don't use "repo" or "repos". |
| OTEP | OpenTelemetry Enhancement Proposal. Write "OTEPs" as plural form. Don't write "OTep" or "otep". |
| OpAMP | Open Agent Management Protocol. Don't write "OPAMP" or "opamp" in descriptions or instructions. |
| OTLP | OpenTelemetry Protocol. Don't write "OTlP" or "otlp" in descriptions or instructions. |
<!-- prettier-ignore-end -->

Make sure that proper nouns, such as other CNCF projects or third-party tools,
Expand Down
46 changes: 0 additions & 46 deletions content/en/docs/contribution-guidelines.md

This file was deleted.

2 changes: 1 addition & 1 deletion layouts/shortcodes/community-lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
{{ template "community-links-list" . }}
{{ end }}

{{ T "community_how_to" . }} <a href="/docs/contribution-guidelines/">{{ T "community_guideline" }}</a>.
{{ T "community_how_to" . }} <a href="/docs/contributing/">{{ T "community_guideline" }}</a>.

{{ define "community-links-list" -}}
{{ range . }}
Expand Down
Loading