From edf7ef111a31ef7a5923e5e7bb34b7cbbfd5ab5a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=AD=C5=A5a=20Kota=C4=8Dka?= Date: Tue, 16 Jun 2026 14:09:41 +0200 Subject: [PATCH] docs #459: consolidate CHANGELOG and add Copilot changelog instructions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .github/copilot-instructions.md | 47 +++++++++++++++++++++++++++++++++ CHANGELOG.md | 5 +++- 2 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 .github/copilot-instructions.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000..af22aaa --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,47 @@ +# Copilot Instructions — java-core + +This file captures conventions used when working with GitHub Copilot in the `java-core` repository and the broader Wultra PowerAuth ecosystem. + +--- + +## Changelog + +`CHANGELOG.md` lives at the **repo root**. Update it as part of every PR — before creating the PR, not after merge. + +### Format + +Follows [Keep a Changelog 1.1.0](https://keepachangelog.com/en/1.1.0/): + +```markdown +# Changelog + +## X.Y.Z (TBA) +### Added +- New feature description [(#N)](https://github.com/wultra/java-core/issues/N) + +### Changed +- Changed behaviour description [(#N)](...) + +### Fixed +- Bug fix description [(#N)](...) + +## 1.2.3 - 2025-03-01 +### Added +- ... +``` + +**Change type subsections** (use only those that apply): +- `Added` — new features +- `Changed` — changes in existing functionality +- `Deprecated` — soon-to-be removed features +- `Removed` — removed features +- `Fixed` — bug fixes +- `Security` — security vulnerability fixes + +**Rules:** +- Always add new entries under `## X.Y.Z (TBA)` (the unreleased section at the top). +- On release, rename `## X.Y.Z (TBA)` to `## x.y.z - YYYY-MM-DD` (ISO 8601 date). +- Each entry: `- [(#N)](url)` — link to the issue, not the PR. +- Use `java-core` issue URLs: `https://github.com/wultra/java-core/issues/N`. +- Descriptions should be human-readable, not raw commit messages (e.g. "Fixed NPE when application list is empty" not "fix #811: add missing import"). +- Skip the Changelog update only for changes with no user-visible impact (e.g. pure CI/tooling changes). diff --git a/CHANGELOG.md b/CHANGELOG.md index b6a0581..b0ff5c2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,9 @@ # Changelog -## 2.2.0 +All notable changes to this project are documented in this file, following the +[Keep a Changelog 1.1.0](https://keepachangelog.com/en/1.1.0/) format. + +## 2.2.0 (TBA) ### Added - Add `logging-support` module with `StructuredArgumentsConverter` for rendering `kv()` structured arguments in plain-text log patterns [(#453)](https://github.com/wultra/java-core/issues/453)