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

initial versioning, pr and issues templates #7

Merged
merged 5 commits into from
Dec 16, 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
92 changes: 92 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
name: Bug report
description: Create a report to help us improve
labels: ["bug", "needs triage"]
body:
- type: markdown
attributes:
value: |
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.

Before filing a bug, please make sure you have searched through [existing bugs](https://github.com/solarwinds/solarwinds-otel-collector/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug) to see if an existing issue covers your bug.
- type: dropdown
id: component
attributes:
label: Component(s)
description: Which component(s) does your bug report concern?
multiple: true
options:
- cmd/solarwinds-otel-collector
- exporter/solarwindsexporter
- type: textarea
attributes:
label: Description
description: Please describe in detail what the issue is.
validations:
required: true
- type: textarea
attributes:
label: Steps to Reproduce
description: Provide sequence of steps to reproduce the issue.
validations:
required: true
- type: textarea
attributes:
label: Expected Result
description: What is the expected result when the steps are reproduced?
validations:
required: true
- type: textarea
attributes:
label: Actual Result
description: What actually happens when the steps are reproduced?
validations:
required: true
- type: input
attributes:
label: SolarWinds OpenTelemetry Collector version
description: What version did you use? (e.g., `v0.113.0`)
validations:
required: true
- type: textarea
attributes:
label: Environment information
description: Please provide any additional information about your installation.
value: |
## Environment
OS: (e.g., "Ubuntu 20.04")
Compiler(if manually compiled): (e.g., "go 14.2")

- type: textarea
attributes:
label: SolarWinds OpenTelemetry Collector configuration
description: Please provide the configuration you are using (e.g. the YAML config file).
placeholder: | # Empty Collector config
receivers:
exporters:
processors:
extensions:
service:
pipelines:
traces:
receivers: []
exporters: []
processors: []
metrics:
receivers: []
exporters: []
processors: []
logs:
receivers: []
exporters: []
processors: []
render: yaml
- type: textarea
attributes:
label: Log output
description: |
Please copy and paste any relevant log output.
render: shell
- type: textarea
attributes:
label: Additional context
description: Any additional information you think may be relevant to this issue.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Feature request
description: Suggest an idea for this project
labels: ["enhancement", "needs triage"]
body:
- type: dropdown
id: component
attributes:
label: Component(s)
description: Which component(s) does your feature request concern?
multiple: true
options:
- cmd/solarwinds-otel-collector
- exporter/solarwindsexporter
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
9 changes: 9 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#### Description
Provide description of the changes made.

<!-- Issue number if applicable
**Tracking Issue:** https://github.com/solarwinds/solarwinds-otel-collector/issues/XXXX
-->

#### Testing
Describe what testing was performed and which tests were added.
12 changes: 12 additions & 0 deletions VERSIONING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Versioning
In general, versioning and stability standards of components maintained in this repository follow the standards laid out by [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector/blob/main/VERSIONING.md).

## SolarWinds OpenTelemetry Collector
The version of SolarWinds OpenTelemetry Collector and its distributions (i.e. Docker image) is based on the version of OpenTelemetry Collector consumed, with reservation of _patch_ version for feature set specific to this distribution.

As a result, the SolarWinds OpenTelemetry collector version is composed in following way:
* **Major** version follows major version of OpenTelemetry Collector consumed
* **Minor** version follows minor version of OpenTelemetry Collector consumed
* **Patch** version is reserved for SolarWinds-specific feature set.

_**Example**: SolarWinds OpenTelemetry Collector v0.113.2 consumes OpenTelemetry Collector 0.113.X and contains 3-distribution specific additions (i.e. updates or additions to components consumed)_
Loading