Skip to content

Commit 24e4502

Browse files
Rob TjalmaRob Tjalma
authored andcommitted
Added copyright guidelines
Signed-off-by: Rob Tjalma <[email protected]>
1 parent cfa3a1e commit 24e4502

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@ The following is a set of guidelines for contributing to the CoMPAS project. The
1515
* [Contributing Code](#contributing-code)
1616
* [Tools to contribute](#tools-to-contribute)
1717
* [Definition of Done](#definition-of-done)
18+
* [Copyright Guidelines](#definition-of-done)
1819

1920
[Styleguides](#styleguides)
2021
* [Git Commit Messages](#git-commit-messages)
2122
* [Java Styleguide](#java-styleguide)
23+
* [Copyright Guidelines](#copyright-guidelines)
2224

2325
[Project Governance](#project-governance)
2426
* [Project Owner](#project-owner)
@@ -180,6 +182,23 @@ As a simple yet instructive example, consider ...
180182
*/
181183
```
182184

185+
### Copyright Guidelines
186+
187+
Contributing to the CoMPAS project also requires to use correct copyright headers in source files.
188+
189+
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.
190+
191+
Example Alliander copyright header for Java files:
192+
```Java
193+
// SPDX-FileCopyrightText: 2020 Alliander N.V.
194+
//
195+
// SPDX-License-Identifier: Apache-2.0
196+
```
197+
198+
Every commit on a Pull Request is being scanned by REUSE. If it fails, the pull requests cannot be merged.
199+
200+
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.
201+
183202
### English language convention
184203

185204
The convention for all the project's documents, including code documentation, website, is to write American English.

0 commit comments

Comments
 (0)