Skip to content

docs #459: consolidate CHANGELOG and add Copilot changelog instructions #468

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vita-kotacka merged 1 commit into from
Jun 16, 2026
Merged

docs #459: consolidate CHANGELOG and add Copilot changelog instructions #468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: `- <Description starting with verb> [(#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).
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

Expand Down