🤖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 a community plus project should have a NR1 Catalog header at the start of the README. If you already have a NR1 Catalog header and this rule is failing, your header may be out of date. For more information please visit https://opensource.newrelic.com/oss-category/. Below is a list of files or patterns that failed:
Doesn't contain a security section (README.md). New Relic recommends having a Security section in your README to address concerns such as vulnerability reporting. This security section should also contain a link to the security policy (found under the "Security" tab of the repository). For an example of this section, please see the NR1 Catalog Template. For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code.
Doesn't contain a link to the security policy for this repository (README.md). New Relic recommends referencing the open source security policy (https://github.com/newrelic/<repo-name>/security/policy or ../../security/policy) in a Security section in the README. For an example of this, please see the NR1 Catalog Template. For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code.
Click to see rules
### ✅ `license-file-exists` #
Found file (`LICENSE`). 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/javascript/oss-template.
### ✅ `readme-contains-discuss-topic` #
Contains a link to the appropriate discuss.newrelic.com topic (`README.md`). New Relic recommends directly linking the your appropriate discuss.newrelic.com topic in the README, allowing developer an alternate method of getting support. For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code.
### ✅ `third-party-notices-file-exists` #
Found file (`THIRD_PARTY_NOTICES.md`). A THIRD_PARTY_NOTICES.md file must be present to grant attribution to all dependencies being used by this project. 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.
### ✅ `github-actions-workflow-file-exists` #
Found file (`.github/workflows/pr.yml`). Any Community Plus project must integrate with GitHub actions. For more information please visit https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view.
### ✅ `nr1-catalog-config-file-exists` #
Found file (`catalog/config.json`).
### ✅ `nr1-catalog-screenshots-directory-exists` #
Found file (`catalog/screenshots`).
### ✅ `nr1-catalog-documentation-file-exists` #
Found file (`catalog/documentation.md`).
### ✅ `package-scripts-present` #
An `eslint-check` and `eslint-fix` npm script found in file (`package.json`). NPM scripts for ESLint (`eslint-check` and `eslint-fix`) are required to properly integrate with the nerdpack system.
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-nr1-catalog-headerreadme-contains-security-sectionreadme-contains-link-to-security-policylicense-file-existsreadme-file-existsreadme-contains-discuss-topicthird-party-notices-file-existsgithub-actions-workflow-file-existsnr1-catalog-config-file-existsnr1-catalog-screenshots-directory-existsnr1-catalog-documentation-file-existspackage-scripts-presentFail #
❌
readme-starts-with-nr1-catalog-header#The README of a community plus project should have a NR1 Catalog header at the start of the README. If you already have a NR1 Catalog header and this rule is failing, your header may be out of date. 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 1 lines do not contain the pattern(s): Open source NR1 Catalog header (see https://opensource.newrelic.com/oss-category).[](https://opensource.newrelic.com/oss-category/#new-relic-one-catalog-project)to file❌
readme-contains-security-section#Doesn't contain a security section (
README.md). New Relic recommends having a Security section in your README to address concerns such as vulnerability reporting. This security section should also contain a link to the security policy (found under the "Security" tab of the repository). For an example of this section, please see the NR1 Catalog Template. For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code.❌
readme-contains-link-to-security-policy#Doesn't contain a link to the security policy for this repository (
README.md). New Relic recommends referencing the open source security policy (https://github.com/newrelic/<repo-name>/security/policyor../../security/policy) in a Security section in the README. For an example of this, please see the NR1 Catalog Template. For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code.Passed #
Click to see rules
### ✅ `license-file-exists` # Found file (`LICENSE`). 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/javascript/oss-template. ### ✅ `readme-contains-discuss-topic` # Contains a link to the appropriate discuss.newrelic.com topic (`README.md`). New Relic recommends directly linking the your appropriate discuss.newrelic.com topic in the README, allowing developer an alternate method of getting support. For more information please visit https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code. ### ✅ `third-party-notices-file-exists` # Found file (`THIRD_PARTY_NOTICES.md`). A THIRD_PARTY_NOTICES.md file must be present to grant attribution to all dependencies being used by this project. 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. ### ✅ `github-actions-workflow-file-exists` # Found file (`.github/workflows/pr.yml`). Any Community Plus project must integrate with GitHub actions. For more information please visit https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view. ### ✅ `nr1-catalog-config-file-exists` # Found file (`catalog/config.json`). ### ✅ `nr1-catalog-screenshots-directory-exists` # Found file (`catalog/screenshots`). ### ✅ `nr1-catalog-documentation-file-exists` # Found file (`catalog/documentation.md`). ### ✅ `package-scripts-present` # An `eslint-check` and `eslint-fix` npm script found in file (`package.json`). NPM scripts for ESLint (`eslint-check` and `eslint-fix`) are required to properly integrate with the nerdpack system.