forked from newrelic/.github
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcommunity-plus.yml
152 lines (152 loc) · 6.67 KB
/
community-plus.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# Schema: https://raw.githubusercontent.com/newrelic-forks/repolinter/master/rulesets/schema.json
version: 2
axioms: {}
rules:
license-file-exists:
level: error
rule:
type: file-existence
options:
globsAny:
- LICENSE*
- COPYING*
nocase: true
fix:
type: file-create
options:
file: LICENSE
replace: true
text:
url: https://www.apache.org/licenses/LICENSE-2.0.txt
policyInfo: >-
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
policyUrl: https://docs.google.com/document/d/1vML4aY_czsY0URu2yiP3xLAKYufNrKsc7o4kjuegpDw/edit
readme-file-exists:
level: error
rule:
type: file-existence
options:
globsAny:
- README*
nocase: true
fix:
type: file-create
options:
file: README.md
text:
url: https://raw.githubusercontent.com/newrelic/open-source-tools/master/nerdpacks/oss-template/README.md
policyInfo: >-
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
policyUrl: https://github.com/newrelic/open-by-default
readme-starts-with-community-plus-header:
level: error
rule:
type: file-starts-with
options:
globsAll:
- README*
nocase: true
lineCount: 5
patterns:
- https:\/\/github\.com\/newrelic\/opensource-website\/raw\/master\/src\/images\/categories\/Community_Plus\.png
- https:\/\/opensource\.newrelic\.com\/oss-category\/#community-plus
human-readable-pattern: Open source Community Plus header (see https://opensource.newrelic.com/oss-category)
flags: i
succeed-on-non-existent: false
fix:
type: file-modify
options:
text: "[](https://opensource.newrelic.com/oss-category/#community-plus)"
write_mode: prepend
newlines:
end: 2
policyInfo: >-
The README of a community plus project should have a community plus
header at the start of the README. If you already have a community plus header
and this rule is failing, your header may be out of date, and you should
update your header with the suggested one below
policyUrl: https://opensource.newrelic.com/oss-category/
readme-contains-link-to-security-policy:
level: error
rule:
type: file-contents
options:
globsAll:
- README*
fail-on-non-exist: true
flags: i
content: (?:(?:https:\/\/github\.com\/newrelic\/[^\/]+)|(?:\.\.\/\.\.))\/security\/policy
human-readable-content: a link to the security policy for this repository
policyInfo: >-
New Relic recommends putting a link to the open source security policy for your project
(`https://github.com/newrelic/<repo-name>/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)
policyUrl: https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code
readme-contains-discuss-topic:
level: error
rule:
type: file-contents
options:
globsAll:
- README*
fail-on-non-exist: true
flags: i
content: discuss\.newrelic\.com
human-readable-content: a link to the appropriate discuss.newrelic.com topic
policyInfo: >-
New Relic recommends directly linking the your appropriate discuss.newrelic.com
topic in the README, allowing developer an alternate method of getting support
policyUrl: https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code
code-of-conduct-file-does-not-exist:
level: error
rule:
type: file-not-exists
options:
globsAll:
- CODE_OF_CONDUCT*
- CODE-OF-CONDUCT*
- CODEOFCODUCT
nocase: true
fix:
type: file-remove
options: {}
policyInfo: >-
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)
policyUrl: https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view
third-party-notices-file-exists:
level: warning
rule:
type: file-existence
options:
globsAny:
- THIRD_PARTY_NOTICES*
- THIRD-PARTY-NOTICES*
- THIRDPARTYNOTICES*
nocase: true
policyInfo: >-
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)
policyUrl: https://docs.google.com/document/d/1y644Pwi82kasNP5VPVjDV8rsmkBKclQVHFkz8pwRUtE/view
formatOptions:
disclaimer: >-
🤖*This issue was automatically generated by [repolinter-action](https://github.com/newrelic/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.*