PaperMC / PaperMC/Velocity

Change the license header to use SPDX abbreviations

Open
#1,829 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

type: feature
Dominant language
Java
Stars
2.3k
Forks
959
Avg merge
5d 10h
Merged PRs (30d)
2

Description

In the proxy module and all other modules that are licensed under the GNU GPL, I'd like to switch from the full license header (as seen in HEADER.txt) to a modern SPDX declaration.

In every file, the header would then change to:

/**
 * SPDX-FileCopyrightText: Copyright (C) $YEAR Velocity Contributors
 * SPDX-License-Identifier: GPL-3.0-only
 */

For more context, see https://spdx.dev/learn/handling-license-info/

The api module is so small (and licensed differently), it might not even need it, but we may consider also using the SPDX declaration there.

This could also be a good oppertunity to bump the copyright year to 2018-2026 on all files, if a substantial change has been made to the file recently (this can probably be automated).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with HEADER.txt and inspect the proxy module plus other GPL-licensed modules to identify every affected file. Confirm whether the differently licensed api module is included, then verify that all applicable files use the SPDX-FileCopyrightText and SPDX-License-Identifier declarations and that any copyright-year updates are justified.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.