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.

Sign up for GitHub

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

Jump to bottom

[documentation] template for new component issue #7058

Merged
merged 5 commits into from
Jan 18, 2022
Merged

[documentation] template for new component issue #7058

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7eb6ef4
[documentation] template for new component issue
Jan 6, 2022
4087736
remove checklist, update content with links to examples
Jan 11, 2022
365d325
update based on feedback
Jan 11, 2022
0fba202
update based on review feedback
Jan 14, 2022
c63e334
Update CONTRIBUTING.md
Jan 18, 2022
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
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/new_component.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: New component proposal
about: Suggest a new component for the project
title: 'New component: '
labels: new component
assignees: ''

---

## The purpose and use-cases of the new component
<!--
This information can be used later on to populate the README for the component. See an example overview [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/awsecscontainermetricsreceiver#overview).
-->

## Example configuration for the component
<!--
This will be used later on when creating `config.go` and added to README as well. See this receiver as an [example](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jaegerreceiver#getting-started).
-->

## Telemetry data types supported
<!--
Any combination of traces, metrics and/or logs is valid here.
-->

## Sponsor (Optional)
<!--
A sponsor is an approver who will be in charge of being the official reviewer of the code. For vendor-specific components, it's good to have a volunteer sponsor. If you can't find one, we'll assign one in a round-robin fashion. For non-vendor components, having a sponsor means that your use case has been validated.

If there are no sponsors yet for the component, it's fine: use the issue as a means to try to find a sponsor for your component.
-->
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ before you begin your work.

## Adding New Components

**Before** any code is written, [open an issue](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/new?assignees=&labels=new+component&template=new_component.md&title=New%20component) providing the following information:

* Who's the sponsor for your component. A sponsor is an approver who will be in charge of being the official reviewer of the code and become a code owner for the component. For vendor-specific components, it's good to have a volunteer sponsor. If you can't find one, we'll assign one in a round-robin fashion. For non-vendor specific components, having a sponsor means that your use case has been validated.
codeboten marked this conversation as resolved.
Show resolved Hide resolved
* Some information about your component, such as the reasoning behind it, use-cases, telemetry data types supported, and anything else you think it's relevant for us to make a decision about accepting the component
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for us to make a decision about accepting the component

Once the issue is opened, what is the process for making a decision? How is the decision indicated?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are your thoughts? The best I can think of is approvers/maintainers commenting on the issue that a decision has been made to approve/reject a proposal.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Labels? "Proposed Component", "Approved Component", and after X weeks close the issue as no decision made => no interest in supporting this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Labels? "Proposed Component", "Approved Component", and after X weeks close the issue as no decision made => no interest in supporting this?

I like this. The "Sponsor Needed" label can be applied until a decision is made.

* The configuration options your component will accept. This will help us understand what it does and have an idea of how the implementation might look like
djaglowski marked this conversation as resolved.
Show resolved Hide resolved


Any component (receiver, processor, exporter, or extension) needs to implement
the interfaces defined on the [core
repository](https://github.com/open-telemetry/opentelemetry-collector).
Expand Down