Skip to content

Commit

Permalink
Update contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
alanwest committed May 23, 2024
1 parent 836e2a8 commit 1189aff
Showing 1 changed file with 37 additions and 11 deletions.
48 changes: 37 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ The [Getting Started Guides](./getting-started-guides/README.md) demonstrate how

## Other Examples

OpenTelemetry is a big ecosystem and everything doesn't fit into the goals of the [getting started guides](#getting-started-guides). These "other examples" demonstrate how other areas of OpenTelemetry fit in with New Relic.
OpenTelemetry is a big ecosystem and everything doesn't fit into the goals of the [getting started guides](#getting-started-guides). These "other examples" demonstrate how other areas of OpenTelemetry fit in with New Relic.

* Collector
* [OpenTelemetry Collector with OTLP and New Relic](./other-examples/collector/nr-config)
* [OpenTelemetry Collector with Host Monitoring and New Relic](./other-examples/collector/host-monitoring)
* [OpenTelemetry Collector with Confluent Cloud and New Relic](./other-examples/collector/confluentcloud)
* [OpenTelemetry Collector with Singlstore and New Relic](./other-examples/collector/singlestore)
* [OpenTelemetry Collector with Singlestore and New Relic](./other-examples/collector/singlestore)
* [OpenTelemetry Collector with HCP Consul and New Relic](./other-examples/collector/hcp-consul)
* Java
* [OpenTelemetry Agent New Relic Config](./other-examples/java/agent-nr-config)
Expand All @@ -45,20 +45,46 @@ OpenTelemetry is a big ecosystem and everything doesn't fit into the goals of th

## Contribute

We encourage your contributions to improve `newrelic-opentelemetry-examples`! Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.
We encourage your contributions to improve `newrelic-opentelemetry-examples`!

Generally, we want to focus on the [getting started guides](#getting-started-guides). We're open to additional examples being added which have a volunteer [codeowner](#codeowners).
Generally, we want to focus on the
[getting started guides](#getting-started-guides)
which all have a strict uniform structure. We're open to additional examples
being added which have a volunteer [codeowner](#codeowners).

We're more selective about additions to [other examples](#other-examples). We use the following criteria to evaluate additions:
We're more selective about additions or substantial changes to
[other examples](#other-examples).

We use the following criteria to evaluate additions:

* Does the example demonstrate a very popular use case or recurring pain point?
* Has someone has volunteered to be a [codeowner](#codeowners)?
* Is there documentation - either in the readme or [docs.newrelic.com](https://docs.newrelic.com/) - which describes how to use the data produced by the example in New Relic?
* Is there continuous integration (i.e. [github action](.github/workflows/pull_request.yml)) ensuring that the example code functions?

If the answer is yes to all those questions, we'll likely accept the contribution.

If you have any questions, or to execute our corporate CLA (which is required if your contribution is on behalf of a company), drop us an email at opensource@newrelic.com.
* Is there documentation - either in the readme or
[docs.newrelic.com](https://docs.newrelic.com/) - which describes how to use
the data produced by the example in New Relic?
* Is there continuous integration (i.e.
[github action](.github/workflows/pull_request.yml)) ensuring that the
example code functions?

If the answer is yes to all those questions, please follow this process:

* Create an issue in this repo and describe the proposed example.
* Follow the issue workflow and make sure the issue is accepted before creating
a PR. If an issue has not been accepted then do not create a PR since it will
be rejected.
* Once the issue is accepted a PR can be created and we will review it.

Trivial changes, wording changes, spelling/grammar
corrections, etc. can be made directly via pull requests and do not require
an associated issue.

Keep in mind that when you submit your pull request, you'll need to sign the
CLA via the click-through using CLA-Assistant. You only have to sign the CLA
one time per project.

If you have any questions, or to execute our corporate CLA (which is required
if your contribution is on behalf of a company), drop us an email at
opensource@newrelic.com.

### Codeowners

Expand Down

0 comments on commit 1189aff

Please sign in to comment.