Skip to content

Commit 7018efc

Browse files
MikeGoldsmithlmolkova
MikeGoldsmith
and
lmolkova
authored
ci: add PR and issue templates (#19)
* ci: add PR and issue templates Ports the contrib templates and adapts for this repo: - PR template: streamlined checklist; drops the contrib-specific "core repo change" section; mentions the Skip Changelog label as the alternative when no changelog entry is needed. - Bug report: GenAI-flavoured environment template (adds prompt for the underlying GenAI library + version). - Feature request: points contributors at the GenAI semantic conventions / spec repo first; uses `enhancement` (an existing label) instead of contrib's `feature-request`. - Slack contact link: routes to the GenAI SIG channel. Assisted-by: Claude Opus 4.7 (1M context) * address review feedback on templates - PR template: rephrase the changelog checklist item so it doesn't imply the contributor must apply the Skip Changelog label (most contributors don't have permission to). Picked up from trask's suggestion in response to Dylan's permission concern. - feature_request.yaml: reword 'implement a fix' -> 'implement it' since this form is for feature requests, not bugs. Per trask's suggestion. Assisted-by: Claude Opus 4.7 (1M context) --------- Co-authored-by: Liudmila Molkova <neskazu@gmail.com>
1 parent 50b9b33 commit 7018efc

4 files changed

Lines changed: 170 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yaml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
name: Bug Report
3+
description: Create a report to help us improve
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report! Please make sure to fill out the entire form below, providing as much context as you can in order to help us triage and track down your bug as quickly as possible.
10+
11+
Before filing a bug, please be sure you have searched through [existing bugs](https://github.com/open-telemetry/opentelemetry-python-genai/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug) to see if your bug is already addressed.
12+
13+
- type: textarea
14+
id: environment
15+
attributes:
16+
label: Describe your environment
17+
description: |
18+
Please describe any aspect of your environment relevant to the problem, including your Python version, [platform](https://docs.python.org/3/library/platform.html), version numbers of installed dependencies, information about your cloud hosting provider, etc. If you're reporting a problem with a specific version of a library in this repo, please check whether the problem has been fixed on main.
19+
value: |
20+
OS: (e.g, Ubuntu)
21+
Python version: (e.g., Python 3.12.0)
22+
Package version: (e.g., 0.5b0)
23+
GenAI library (e.g. anthropic, openai) and version:
24+
25+
- type: textarea
26+
attributes:
27+
label: What happened?
28+
description: Please provide as much detail as you reasonably can.
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
attributes:
34+
label: Steps to Reproduce
35+
description: Provide a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible and the needed steps to reproduce the problem.
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
attributes:
41+
label: Expected Result
42+
description: What did you expect to see?
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
attributes:
48+
label: Actual Result
49+
description: What did you see instead?
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: additional-context
55+
attributes:
56+
label: Additional context
57+
description: Add any other context about the problem here.
58+
placeholder: Any additional information...
59+
60+
- type: dropdown
61+
id: contribute
62+
attributes:
63+
label: Would you like to implement a fix?
64+
description: For guidance on how to get started, refer to the [contribution guide](https://github.com/open-telemetry/opentelemetry-python-genai/blob/main/CONTRIBUTING.md).
65+
options:
66+
- "No"
67+
- "Yes"
68+
69+
- type: dropdown
70+
attributes:
71+
label: Tip
72+
description: This element is static, used to render a helpful sub-heading for end-users and community members to help prioritize issues. Please leave as is.
73+
options:
74+
- <sub>[React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>
75+
default: 0

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: Slack
3+
url: https://cloud-native.slack.com/archives/C06KR7ARS3X
4+
about: Or the `#otel-genai-instrumentation` channel in the CNCF Slack instance.

‎.github/ISSUE_TEMPLATE/feature_request.yaml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: Feature Request
3+
description: Suggest an idea for this project
4+
labels: [enhancement]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Before opening a feature request against this repo, consider whether the feature should/could be implemented in the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification) or [GenAI semantic conventions](https://github.com/open-telemetry/semantic-conventions/tree/main/docs/gen-ai). If so, please open an issue there first.
10+
- type: textarea
11+
id: related-problem
12+
attributes:
13+
label: What problem do you want to solve?
14+
description: Is your feature request related to a problem? If so, provide a concise description of the problem.
15+
placeholder: Describe the problem and include relevant issue IDs
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: solution
20+
attributes:
21+
label: Describe the solution you'd like
22+
description: What do you want to happen instead? What is the expected behavior?
23+
placeholder: I'd like to ...
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Describe alternatives you've considered
30+
description: Which alternative solutions or features have you considered?
31+
placeholder: Some potential solutions
32+
validations:
33+
required: false
34+
- type: textarea
35+
id: additional-context
36+
attributes:
37+
label: Additional Context
38+
description: Add any other context about the feature request here.
39+
placeholder: Some related requests in other projects or upstream spec proposals.
40+
validations:
41+
required: false
42+
- type: dropdown
43+
id: contribute
44+
attributes:
45+
label: Would you like to implement it?
46+
description: |
47+
For guidance on how to get started, refer to the [contribution guide](https://github.com/open-telemetry/opentelemetry-python-genai/blob/main/CONTRIBUTING.md).
48+
options:
49+
- "No"
50+
- "Yes"
51+
52+
- type: dropdown
53+
attributes:
54+
label: Tip
55+
description: This element is static, used to render a helpful sub-heading for end-users and community members to help prioritize issues. Please leave as is.
56+
options:
57+
- <sub>[React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>
58+
default: 0

‎.github/pull_request_template.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Description
2+
3+
Please include a summary of the change and which issue, if any, is fixed.
4+
Include the motivation and context for the change.
5+
6+
Fixes # (issue)
7+
8+
## Type of change
9+
10+
Please delete options that are not relevant.
11+
12+
- [ ] Bug fix (non-breaking change which fixes an issue)
13+
- [ ] New feature (non-breaking change which adds functionality)
14+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
15+
- [ ] This change requires a documentation update
16+
17+
# How has this been tested?
18+
19+
Please describe the tests that you ran to verify your changes. Provide
20+
instructions so we can reproduce. List any relevant details for your test
21+
configuration.
22+
23+
- [ ] Test A
24+
25+
# Checklist
26+
27+
See [CONTRIBUTING.md](https://github.com/open-telemetry/opentelemetry-python-genai/blob/main/CONTRIBUTING.md)
28+
for the style guide, changelog guidance, and more.
29+
30+
- [ ] Followed the style guidelines of this project
31+
- [ ] Changelog updated if the change requires an entry
32+
- [ ] Unit tests added
33+
- [ ] Documentation updated

0 commit comments

Comments
 (0)