🤖This issue was automatically generated by repolinter-action, developed by the Open Source and Developer Advocacy team at New Relic. This issue will be automatically updated or closed when changes are pushed. If you have any problems with this tool, please feel free to open a GitHub issue or give us a ping in #help-opensource.
This Repolinter run generated the following results:
The README of an example code project should have an example code header at the start of the README. If you already have an example code header and this rule is failing, your header may be out of date, and you should update your header with the suggested one below. For more information please visit https://opensource.newrelic.com/oss-category/. Below is a list of files or patterns that failed:
🔨 Suggested Fix: prepend the latest code snippet found at https://github.com/newrelic/opensource-website/wiki/Open-Source-Category-Snippets#code-snippet-4 to file
Click to see rules
### ⚠️ `third-party-notices-file-exists` #
A [`THIRD_PARTY_NOTICES.md`](https://github.com/newrelic/opensource-website/blob/develop/THIRD_PARTY_NOTICES.md) file can be present in your repository to grant attribution to all dependencies being used by this project. This document is necessary if you are using third-party source code in your project, with the exception of code referenced outside the project's compiled/bundled binary (ex. some Java projects require modules to be pre-installed in the classpath, outside the project binary and therefore outside the scope of the `THIRD_PARTY_NOTICES`). Please review your project's dependencies and create a THIRD_PARTY_NOTICES.md file if necessary. For JavaScript projects, you can generate this file using the [oss-cli](https://github.com/newrelic/newrelic-oss-cli). For more information please visit https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view. Did not find a file matching the specified patterns. Below is a list of files or patterns that failed:
- `THIRD_PARTY_NOTICES*`
- `THIRD-PARTY-NOTICES*`
- `THIRDPARTYNOTICES*`
Click to see rules
### ✅ `license-file-exists` #
Found file (`LICENSE.md`). New Relic requires that all open source projects have an associated license contained within the project. This license must be permissive (e.g. non-viral or copyleft), and we recommend Apache 2.0 for most use cases. For more information please visit https://docs.google.com/document/d/1vML4aY_czsY0URu2yiP3xLAKYufNrKsc7o4kjuegpDw/edit.
### ✅ `readme-file-exists` #
Found file (`README.md`). New Relic requires a README file in all projects. This README should give a general overview of the project, and should point to additional resources (security, contributing, etc.) where developers and users can learn further. For more information please visit https://github.com/newrelic/open-source-tools/tree/master/nerdpacks/oss-template.
### ✅ `readme-contains-link-to-security-policy` #
Contains a link to the security policy for this repository (`README.md`). New Relic recommends putting a link to the open source security policy for your project (`https://github.com/newrelic//security/policy` or `../../security/policy`) in the README. For an example of this, please see the "a note about vulnerabilities" section of the [Open By Default repository](https://github.com/newrelic/open-by-default#contribute). For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code.
### ✅ `code-of-conduct-should-not-exist-here` #
New Relic has moved the `CODE_OF_CONDUCT` file to a [centralized location](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) where it is referenced automatically by every repository in the New Relic organization. Because of this change, any other `CODE_OF_CONDUCT` file in a repository is now redundant and should be removed. Note that you will need to adjust any links to the local `CODE_OF_CONDUCT` file in your documentation to point to the central file (`README` and `CONTRIBUTING` will probably have links that need updating). For more information please visit https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view. Did not find a file matching the specified patterns. All files passed this test.
Repolinter Report
🤖This issue was automatically generated by repolinter-action, developed by the Open Source and Developer Advocacy team at New Relic. This issue will be automatically updated or closed when changes are pushed. If you have any problems with this tool, please feel free to open a GitHub issue or give us a ping in #help-opensource.
readme-starts-with-example-code-headeross-docs-no-broken-linksthird-party-notices-file-existslicense-file-existsreadme-file-existsreadme-contains-link-to-security-policycode-of-conduct-should-not-exist-hereFail #
❌
readme-starts-with-example-code-header#The README of an example code project should have an example code header at the start of the README. If you already have an example code header and this rule is failing, your header may be out of date, and you should update your header with the suggested one below. For more information please visit https://opensource.newrelic.com/oss-category/. Below is a list of files or patterns that failed:
README.md: The first 5 lines do not contain the pattern(s): Open source Example Code header (see https://opensource.newrelic.com/oss-category).the latest code snippet found at https://github.com/newrelic/opensource-website/wiki/Open-Source-Category-Snippets#code-snippet-4to file❌
oss-docs-no-broken-links#Found broken links.
https://hackerone.com/newrelic(status code undefined) (README.md).Warning #
Click to see rules
### ⚠️ `third-party-notices-file-exists` # A [`THIRD_PARTY_NOTICES.md`](https://github.com/newrelic/opensource-website/blob/develop/THIRD_PARTY_NOTICES.md) file can be present in your repository to grant attribution to all dependencies being used by this project. This document is necessary if you are using third-party source code in your project, with the exception of code referenced outside the project's compiled/bundled binary (ex. some Java projects require modules to be pre-installed in the classpath, outside the project binary and therefore outside the scope of the `THIRD_PARTY_NOTICES`). Please review your project's dependencies and create a THIRD_PARTY_NOTICES.md file if necessary. For JavaScript projects, you can generate this file using the [oss-cli](https://github.com/newrelic/newrelic-oss-cli). For more information please visit https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view. Did not find a file matching the specified patterns. Below is a list of files or patterns that failed: - `THIRD_PARTY_NOTICES*` - `THIRD-PARTY-NOTICES*` - `THIRDPARTYNOTICES*`Passed #
Click to see rules
### ✅ `license-file-exists` # Found file (`LICENSE.md`). New Relic requires that all open source projects have an associated license contained within the project. This license must be permissive (e.g. non-viral or copyleft), and we recommend Apache 2.0 for most use cases. For more information please visit https://docs.google.com/document/d/1vML4aY_czsY0URu2yiP3xLAKYufNrKsc7o4kjuegpDw/edit. ### ✅ `readme-file-exists` # Found file (`README.md`). New Relic requires a README file in all projects. This README should give a general overview of the project, and should point to additional resources (security, contributing, etc.) where developers and users can learn further. For more information please visit https://github.com/newrelic/open-source-tools/tree/master/nerdpacks/oss-template. ### ✅ `readme-contains-link-to-security-policy` # Contains a link to the security policy for this repository (`README.md`). New Relic recommends putting a link to the open source security policy for your project (`https://github.com/newrelic/