Merge pull request fsfe#1021 from carmenbianca/protokolo

Add Protokolo and PR template

.github/pull_request_template.md

@@ -0,0 +1,16 @@
+<!--
+Before submitting a PR, please read CONTRIBUTING.md. Non-trivial changes should
+be discussed in an issue before committing to a PR.
+
+Please succinctly describe your changes.
+-->
+
+<!-- Next, let's do a check list. -->
+
+- [ ] Added a change log entry in `changelog.d/<directory>/`.
+- [ ] Added self to copyright blurb of touched files.
+- [ ] Added self to `AUTHORS.rst`.
+- [ ] Wrote tests.
+- [ ] (Situational) Documented my changes in `docs/man/`.
+- [x] I agree to license my contribution under the licenses indicated in the
+      changed files.

CHANGELOG.md

@@ -23,21 +23,7 @@ The versions follow [semantic versioning](https://semver.org) for the `reuse`
 CLI command and its behaviour. There are no guarantees of stability for the
 `reuse` Python library.
 
-<!--
-## Unreleased - YYYY-MM-DD
-
-### Added
-
-### Changed
-
-### Deprecated
-
-### Removed
-
-### Fixed
-
-### Security
--->
+<!-- protokolo-section-tag -->
 
 ## Unreleased - YYYY-MM-DD
 

CONTRIBUTING.md

@@ -48,9 +48,25 @@ feature that may not be accepted.
 When making a pull request, don't hesitate to add yourself to the AUTHORS.rst
 file and the copyright headers of the files you touch.
 
-Every pull request should add an entry in `CHANGELOG.md`. Some exceptions apply,
-such as changes which are too tiny to be significant, certain refactorings, or
-fixes to pull requests which were already merged, but not yet released.
+### Change log
+
+Every pull request should add a change log entry. Change log entries go into
+`changelog.d/<directory>/<name>.md`, where `<directory>` is the appropriate
+category for the change set, and where `<name>` is a short or random name for
+your change set.
+
+The contents of the file should typically look like this:
+
+```markdown
+- Added a new feature. (#pr_number)
+```
+
+At release time, the contents of the `changelog.d/` directory are compiled into
+`CHANGELOG.md` using `protokolo compile`.
+
+Some PRs are excepted from adding change log entries, such as changes which are
+too tiny to be significant, certain refactorings, or fixes to pull requests
+which were already merged, but not yet released.
 
 ## Translation
 

REUSE.toml

@@ -50,7 +50,12 @@ SPDX-FileCopyrightText = "2017 Free Software Foundation Europe e.V. <https://fsf
 SPDX-License-Identifier = "CC0-1.0"
 
 [[annotations]]
-path = "flake.lock"
+path = ".github/pull_request_template.md"
 precedence = "override"
-SPDX-FileCopyrightText = "2017 Free Software Foundation Europe e.V. <https://fsfe.org>"
+SPDX-FileCopyrightText = "2024 Free Software Foundation Europe e.V. <https://fsfe.org>"
 SPDX-License-Identifier = "CC0-1.0"
+
+[[annotations]]
+path = "changelog.d/**/*.md"
+SPDX-FileCopyrightText = "REUSE contributors"
+SPDX-License-Identifier = "CC-BY-SA-4.0 OR GPL-3.0-or-later"

changelog.d/.protokolo.toml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Free Software Foundation Europe e.V. <https://fsfe.org>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+[protokolo.section]
+title = "${version} - ${date}"
+level = 2

changelog.d/added/.protokolo.toml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Free Software Foundation Europe e.V. <https://fsfe.org>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+[protokolo.section]
+title = "Added"
+order = 1

changelog.d/changed/.protokolo.toml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Free Software Foundation Europe e.V. <https://fsfe.org>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+[protokolo.section]
+title = "Changed"
+order = 2

changelog.d/deprecated/.protokolo.toml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Free Software Foundation Europe e.V. <https://fsfe.org>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+[protokolo.section]
+title = "Deprecated"
+order = 3

changelog.d/fixed/.protokolo.toml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Free Software Foundation Europe e.V. <https://fsfe.org>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+[protokolo.section]
+title = "Fixed"
+order = 5

changelog.d/removed/.protokolo.toml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Free Software Foundation Europe e.V. <https://fsfe.org>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+[protokolo.section]
+title = "Removed"
+order = 4

changelog.d/security/.protokolo.toml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Free Software Foundation Europe e.V. <https://fsfe.org>
+#
+# SPDX-License-Identifier: CC0-1.0
+
+[protokolo.section]
+title = "Security"
+order = 6

pyproject.toml

@@ -80,6 +80,7 @@ bumpver = ">=2023.1129"
 pylint = ">=2.12.2"
 mypy = ">=1.0"
 GitPython = ">=3.0"
+protokolo = { version =  ">=2.1.0", python = "^3.11" }
 
 [tool.poetry.group.lsp]
 optional = true
@@ -122,6 +123,11 @@ push = false
     '__version__ = "{pep440_version}"$',
 ]
 
+[tool.protokolo]
+changelog = "CHANGELOG.md"
+markup = "markdown"
+directory = "changelog.d"
+
 [tool.black]
 line-length = 80