You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19Lines changed: 19 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,11 +15,13 @@ The following is a set of guidelines for contributing to the CoMPAS project. The
15
15
*[Contributing Code](#contributing-code)
16
16
*[Tools to contribute](#tools-to-contribute)
17
17
*[Definition of Done](#definition-of-done)
18
+
*[Copyright Guidelines](#definition-of-done)
18
19
*[How-to begin](#how-to-begin)
19
20
20
21
[Styleguides](#styleguides)
21
22
*[Git Commit Messages](#git-commit-messages)
22
23
*[Java Styleguide](#java-styleguide)
24
+
*[Copyright Guidelines](#copyright-guidelines)
23
25
24
26
[Project Governance](#project-governance)
25
27
*[Project Owner](#project-owner)
@@ -233,6 +235,23 @@ As a simple yet instructive example, consider ...
233
235
*/
234
236
```
235
237
238
+
### Copyright Guidelines
239
+
240
+
Contributing to the CoMPAS project also requires to use correct copyright headers in source files.
241
+
242
+
For each CoMPAS repository, we created / will create a Github Action featuring [REUSE](https://reuse.software/). REUSE is a piece of software which checks for correct copyright information in files defined in a [specification](https://reuse.software/spec/). The specification is based on best practices and the use of [SPDX](https://spdx.dev/) identifiers.
243
+
244
+
Example Alliander copyright header for Java files:
245
+
```Java
246
+
// SPDX-FileCopyrightText: 2020 Alliander N.V.
247
+
//
248
+
// SPDX-License-Identifier: Apache-2.0
249
+
```
250
+
251
+
Every commit on a Pull Request is being scanned by REUSE. If it fails, the pull requests cannot be merged.
252
+
253
+
For more tips on using REUSE (for example with a small command line tool), check the [Tips: Copyright & Licensing](https://wiki.lfenergy.org/pages/viewpage.action?pageId=10996220) wiki page.
254
+
236
255
### English language convention
237
256
238
257
The convention for all the project's documents, including code documentation, website, is to write American English.
0 commit comments