Skip to content

Commit f024b8b

Browse files
committed
Update CONTRIBUTING with license/package scanning info
Signed-off-by: Victor Chang <[email protected]>
1 parent 64d52b5 commit f024b8b

File tree

1 file changed

+52
-10
lines changed

1 file changed

+52
-10
lines changed

CONTRIBUTING.md

Lines changed: 52 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -89,17 +89,59 @@ An [EditorConfig](https://editorconfig.org "EditorConfig homepage") file (`.edit
8989
All source code files should start with this paragraph:
9090

9191
```
92-
// Copyright <YEAR FROM-YEAR TO> MONAI Consortium
93-
// Licensed under the Apache License, Version 2.0 (the "License");
94-
// you may not use this file except in compliance with the License.
95-
// You may obtain a copy of the License at
96-
// http://www.apache.org/licenses/LICENSE-2.0
97-
// Unless required by applicable law or agreed to in writing, software
98-
// distributed under the License is distributed on an "AS IS" BASIS,
99-
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
100-
// See the License for the specific language governing permissions and
101-
// limitations under the License.
92+
/*
93+
* Copyright YYYY[-YYYY] MONAI Consortium
94+
*
95+
* Licensed under the Apache License, Version 2.0 (the "License");
96+
* you may not use this file except in compliance with the License.
97+
* You may obtain a copy of the License at
98+
*
99+
* http://www.apache.org/licenses/LICENSE-2.0
100+
*
101+
* Unless required by applicable law or agreed to in writing, software
102+
* distributed under the License is distributed on an "AS IS" BASIS,
103+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
104+
* See the License for the specific language governing permissions and
105+
* limitations under the License.
106+
*/
107+
102108
```
109+
A CI step (Check License Header) scans the entire repository to ensure all files include the license mentioned above text.
110+
111+
Please refer to [skywalking-eyes](https://github.com/apache/skywalking-eyes) on how to execute the tool locally and use the [.licenserc.yaml](./.licenserc.yaml) to configure scanning options.
112+
113+
###### License Scanning
114+
115+
We operate under the Apache 2.0 license, meaning we can only use packages with specific permissive licenses. Below are the lists of permits we can/maybe can allow.
116+
117+
**Green list** (Can be committed without approval)
118+
119+
- MIT
120+
- Apache 2.0
121+
- Dotnet
122+
123+
**Amber list** (Requires approval from the maintainers)
124+
125+
- BSD
126+
127+
**Red list** (Cannot be used)
128+
129+
- Anything other than the above
130+
131+
No matter the license of the new package that is added, you will notice that the CI license scanner (Perform License Scanning step) will fail and state that the dependency needs approval. This CI step is to ensure that no packages slip through unchecked. When this happens, if your package's license is on the green-list, you can add it to the allow-list at [doc/dependency_decision.yml](./doc/dependency_decisions.yml) with the below template.
132+
133+
```yaml
134+
- - :approve
135+
- PackageName
136+
- :who: YourName (YourUsername)
137+
:why: LicenseName - CorrectLicenceURL
138+
:versions: []
139+
:when: CurrentDate/Time e.g. 2022-04-14 09:14:32
140+
```
141+
142+
If your package is on the Amber list, please make a maintainer aware and let them go through the review process before adding it to the allowlist.
143+
144+
If your package is on the Red list, you will have to look for another package that achieves the same aim with a more permissive license.
103145
104146
#### Test Projects
105147

0 commit comments

Comments
 (0)