Skip to content

Commit 10ba698

Browse files
authored
Revise and consolidate contrib guidance for 1st-timers; add note about AI (#8517)
1 parent d00e8f3 commit 10ba698

File tree

4 files changed

+70
-60
lines changed

4 files changed

+70
-60
lines changed

content/en/docs/contributing/_index.md

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,43 @@ title: Contributing
33
aliases: [/docs/contribution-guidelines]
44
sidebar_root_for: self
55
weight: 980
6+
cascade:
7+
chooseAnIssueAtYourLevel: |
8+
Make sure to [choose an issue] that matches your level of **experience** and
9+
**understanding** of OpenTelemetry. Avoid overreaching your capabilities.
10+
_issues: https://github.com/open-telemetry/opentelemetry.io/issues
11+
_issue: https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A
612
---
713

8-
Thanks for your interest in contributing to the OpenTelemetry docs and website.
14+
{{% alert title="Thank you for your interest!" color=success %}}
15+
16+
Thank you for your interest in contributing to the OpenTelemetry docs and
17+
website.
18+
19+
{{% /alert %}}
20+
21+
## <i class='far fa-exclamation-triangle text-warning '></i> First time contributing? {#first-time-contributing}
22+
23+
- **[Choose an issue]** with the following labels:
24+
- [Good first issue](<{{% param _issue %}}%22good+first+issue%22>)
25+
- [Help wanted](<{{% param _issue %}}%3A%22help+wanted%22>)
26+
27+
{{% alert title="We do not assign issues" color="warning" %}}
28+
29+
We **_do not_ assign issues** to those who have not already made contributions
30+
to the [OpenTelemetry organization][org], unless part of a confirmed
31+
mentorship or onboarding process.
32+
33+
[org]: https://github.com/open-telemetry
34+
35+
{{% /alert %}}
36+
37+
- {{% param chooseAnIssueAtYourLevel %}}
38+
39+
- Want to work other issues or larger changes? [Discuss it with maintainers
40+
first][].
41+
42+
[discuss it with maintainers first]: issues/#fixing-an-existing-issue
943

1044
## Jump right in!
1145

@@ -20,17 +54,8 @@ What do you want to do?
2054
- [Submitting content]
2155

2256
[Prerequisites]: prerequisites/
23-
[Issues]: issues/
2457
[Submitting content]: pull-requests/
2558

26-
{{% alert title="<i class='far fa-exclamation-triangle'></i> First time contributing? " %}}
27-
28-
Eager first-time contributors, see
29-
[Fixing an existing issue](issues/#fixing-an-existing-issue) for important
30-
guidance.
31-
32-
{{% /alert %}}
33-
3459
## What can I contribute to?
3560

3661
OpenTelemetry documentation contributors:
@@ -48,6 +73,7 @@ the community [OpenTelemetry New Contributor Guide]. Every [OTel
4873
repository][org] for language implementations, the Collector, and conventions
4974
have their own project-specific contributing guides.
5075

76+
[choose an issue]: issues/#fixing-an-existing-issue
77+
[issues]: issues/
5178
[OpenTelemetry New Contributor Guide]:
5279
https://github.com/open-telemetry/community/blob/main/guides/contributor
53-
[org]: https://github.com/open-telemetry

content/en/docs/contributing/issues.md

Lines changed: 7 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -5,50 +5,20 @@ description:
55
improvement.
66
weight: 10
77
_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
98
cSpell:ignore: prepopulated
109
---
1110

12-
<style>
13-
/* Force all list to be compact. */
14-
li > p {
15-
margin-bottom: 0;
16-
}
17-
18-
/* Style "first time" alert */
19-
.alert--first-timer {
20-
margin: 0.5rem 0 !important;
21-
22-
> blockquote {
23-
margin-top: 1rem;
24-
margin-bottom: 0;
25-
border-left-color: var(--bs-warning);
26-
background-color: var(--bs-danger-bg-subtle);
27-
> *:last-child {
28-
margin-bottom: 0;
29-
}
30-
}
31-
}
32-
</style>
33-
3411
## Fixing an existing issue
3512

36-
One of the best ways to help make OTel docs better is to fix an existing issue.
13+
One of the best ways to help improve the documentation is to fix an existing
14+
issue.
3715

3816
1. Browse through the list of [issues]({{% param _issues %}}).
39-
2. Select an issue that you would like to work on, ideally one that you can fix
40-
in a short amount of time. <a name="first-issue"></a>
41-
{{% alert title="First time contributing?" color="primary alert--first-timer" %}}
42-
43-
Select an issue with the following labels:
44-
- [Good first issue](<{{% param _issue %}}%22good+first+issue%22>)
45-
- [Help wanted](<{{% param _issue %}}%3A%22help+wanted%22>)
46-
47-
> **NOTE**: we **_do not_ assign issues** to those who have not already made
48-
> contributions to the [OpenTelemetry organization][org], unless part of a
49-
> mentorship or onboarding process.
50-
>
51-
> [org]: https://github.com/open-telemetry
17+
2. Select an issue that you would like to work on.
18+
19+
{{% alert color="warning" %}}
20+
21+
{{% param chooseAnIssueAtYourLevel %}}
5222

5323
{{% /alert %}}
5424

content/en/docs/contributing/pull-requests.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,24 @@ To contribute new or improve existing documentation, submit a [pull request][PR]
1515
- Otherwise, see [Work from a local fork](#fork-the-repo) to learn how to make
1616
changes in your own local development environment.
1717

18-
{{% alert title="Contributor License Agreement (CLA)" color=warning %}}
18+
## Generative AI contribution policy {#using-ai}
1919

20-
All contributors are required to [sign a Contributor License Agreement
21-
(CLA)][CLA] before changes can be reviewed and merged.
20+
{{% alert color="warning" %}}
2221

23-
[CLA]: ../prerequisites/#cla
22+
Generative AI is allowed, but **you are responsible** for **reviewing and
23+
_validating_** all AI-generated content &mdash; if you don't understand it,
24+
don't submit it!
25+
26+
This is especially important for [first-time contributors]. For details, see our
27+
[Generative AI Contribution Policy][].
2428

2529
{{% /alert %}}
2630

27-
{{% alert title="Tip: Draft status" %}}
31+
[first-time contributors]: ../#first-time-contributing
32+
[Generative AI Contribution Policy]:
33+
https://github.com/open-telemetry/community/blob/main/policies/genai.md
2834

29-
Set the status of your pull request to **Draft** to let maintainers know that
30-
the content isn't ready for review yet. Maintainers may still comment or do
31-
high-level reviews, though they won't review the content in full until you
32-
remove the draft status.
33-
34-
{{% /alert %}}
35+
## How to contribute
3536

3637
The following figure illustrates how to contribute new documentation.
3738

@@ -43,7 +44,7 @@ flowchart LR
4344
B[Fork the repo in GitHub] --- C[Write docs in markdown<br>and build site with Hugo]
4445
C --- D[Push source to the fork]
4546
D --- E[Open a pull request]
46-
E --- F[Sign the CNCF CLA]
47+
E --- F[Sign the <a href="../prerequisites/#cla">CNCF CLA</a>]
4748
end
4849
4950
classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
@@ -56,6 +57,15 @@ class first,second white
5657

5758
_Figure 1. Contributing new content._
5859

60+
{{% alert title="Tip: Draft status" %}}
61+
62+
Set the status of your pull request to **Draft** to let maintainers know that
63+
the content isn't ready for review yet. Maintainers may still comment or do
64+
high-level reviews, though they won't review the content in full until you
65+
remove the draft status.
66+
67+
{{% /alert %}}
68+
5969
## Using GitHub {#changes-using-github}
6070

6171
### Edit and submit changes from your browser {#page-edit-from-browser}

static/refcache.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6539,6 +6539,10 @@
65396539
"StatusCode": 206,
65406540
"LastSeen": "2025-11-13T09:47:02.382315365Z"
65416541
},
6542+
"https://github.com/open-telemetry/community/blob/main/policies/genai.md": {
6543+
"StatusCode": 206,
6544+
"LastSeen": "2025-11-26T13:27:01.195911-05:00"
6545+
},
65426546
"https://github.com/open-telemetry/community/blob/main/project-management.md": {
65436547
"StatusCode": 206,
65446548
"LastSeen": "2025-11-20T09:40:33.72041867Z"

0 commit comments

Comments
 (0)