reuse-tool

reuse-tool copied to clipboard

Linters like PyMarkdown complain about the license comment starting Markdown documents.

README.md:1:1: MD041: First line in file should be a top level heading (first-line-heading,first-line-h1)

While the reuse tool still puts the license comment in line 1, we can showcase in this repository how to handle this situation through manual editing to both please the linter and stay REUSE-compliant.

This change relates to the discussion in issue #868.

• [ ] Added a change log entry in changelog.d/<directory>/.
• [ ] Added self to copyright blurb of touched files.
• [ ] Added self to AUTHORS.rst. **)
• [ ] Wrote tests.
• [ ] Documented my changes in docs/man/ or elsewhere.
• [x] My changes do not contradict the current specification.
• [x] I agree to license my contribution under the licenses indicated in the changed files.

**) As this is a trivial change, I waive my right to be credited as an author.