Skip to content

Open Source Category Snippets

Jump to bottom
nr-opensource-bot edited this page Feb 21, 2023 · 5 revisions

Open Source Category README Requirements

This document provides the code snippets for New Relic open source README files. You can find the details on meaning of these category here.

Category Headers

Every public repository in the newrelic and newrelic-experimental GitHub organizations must leverage one of the following categories.

  • New Relic Experimental
  • Community Project
  • Community Plus
  • New Relic One Catalog Project
  • Example Code
  • Archived

Category: New Relic Experimental

New Relic Open Source experimental project banner.

Category Description and Requirements

See here.

Code snippet

Required: Copy and paste the following into the top of your project's README.

<a href="https://opensource.newrelic.com/oss-category/#new-relic-experimental"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Experimental.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Experimental.png"><img alt="New Relic Open Source experimental project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Experimental.png"></picture></a>

Category: Community Project

New Relic Open Source community project banner.

Category Description and Requirements

See here.

Code snippet

Required: Copy and paste the following into the top of your project's README.

<a href="https://opensource.newrelic.com/oss-category/#community-project"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Community_Project.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Project.png"><img alt="New Relic Open Source community project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Project.png"></picture></a>

Category: Community Plus

New Relic Open Source community plus project banner.

Category Description and Requirements

See here.

Code snippet

Required: Copy and paste the following into the top of your project's README.

<a href="https://opensource.newrelic.com/oss-category/#community-plus"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Community_Plus.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"><img alt="New Relic Open Source community plus project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"></picture></a>

Category: New Relic One Catalog Project

New Relic Open Source catalog project banner.

Category Description and Requirements

See here.

Code snippet

Required: Copy and paste the following into the top of your project's README.

<a href="https://opensource.newrelic.com/oss-category/#new-relic-one-catalog-project"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/New_Relic_One_Catalog_Project.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/New_Relic_One_Catalog_Project.png"><img alt="New Relic Open Source catalog project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/New_Relic_One_Catalog_Project.png"></picture></a>

Category: Example Code

New Relic Open Source example project banner.

Category Description and Requirements

See here.

Code snippet

Required: Copy and paste the following into the top of your project's README.

<a href="https://opensource.newrelic.com/oss-category/#example-code"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Example_Code.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Example_Code.png"><img alt="New Relic Open Source example project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Example_Code.png"></picture></a>

Category: Archived

New Relic Open Source archived project banner.

Category Description and Requirements

See here.

Code snippet

Required: Copy and paste the following into the top of your project's README.

<a href="https://opensource.newrelic.com/oss-category/#archived"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Archived.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Archived.png"><img alt="New Relic Open Source archived project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Archived.png"></picture></a>
Clone this wiki locally