apache / apache/maven

[MNG-7734] Default configuration file (settings.xml) contains copyright notice

Open
#9,243 3 comments 0 reactions 0 assignees View on GitHub
priority:minor
Dominant language
Java
Stars
5.3k
Forks
3.1k
Avg merge
20h 42m
Merged PRs (30d)
297

Description

**[Philippe Cloutier](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=chealer)** opened **[MNG-7734](https://issues.apache.org/jira/browse/MNG-7734?redirect=false)** and commented

[The default contents of Maven's settings.xml configuration file](https://gitbox.apache.org/repos/asf?p=maven.git;a=blob_plain;f=apache-maven/src/assembly/maven/conf/settings.xml;hb=HEAD) start with the following comment:

```xml

```

As a result, my organization has _settings.xml_ files which start with that copyright notice. This is confusing and distracting, making an already long file even longer. A casual look makes it seem as if that file is unmodified source, while it is in fact a configuration file.

It is true that the file contains sizable test comments which must be subject copyright, so the notice is correct and has some value. However, its prominence (length and position, before even the file's description) increases the risk of confusion.

Since copyright notices are not necessary to copyright protection, since the Apache License is permissive and since the value of copyrights on that file are limited, I recommend to remove that notice from settings.xml.

---

**Affects:** 3.9.0

Contributor guide

Open the contributing guide

Research direction

Open apache-maven/src/assembly/maven/conf/settings.xml and inspect the leading copyright comment. Remove that notice while preserving the file description and the test-related comments that remain relevant.

Written by the indexing model from the issue text.

Assessment

Domain
build-system
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.