Skip to content

Commit d14e4ee

Browse files
author
Rob Tjalma
authored
Merge branch 'master' into how_to_start_developing
2 parents 8769812 + 24e4502 commit d14e4ee

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,11 +15,13 @@ 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
* [How-to begin](#how-to-begin)
1920

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

2426
[Project Governance](#project-governance)
2527
* [Project Owner](#project-owner)
@@ -233,6 +235,23 @@ As a simple yet instructive example, consider ...
233235
*/
234236
```
235237

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+
236255
### English language convention
237256

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

0 commit comments

Comments
 (0)