Skip to content

docs: modernize README and add community files - #20

Merged
szkiba merged 1 commit into
mainfrom
docs-modernization
Nov 17, 2026
Merged

szkiba merged 1 commit into
mainfrom
docs-modernization

Conversation

@szkiba

@szkiba szkiba commented Nov 16, 2026

Copy link
Copy Markdown
Contributor

The README still described the SourceForge migration with a stale roadmap, and the repository had no contributing guide, code of conduct, security policy or changelog. This brings the docs in line with the 0.6.0 work.

The README now covers status, install, a quick start, the CVE-2022-41404 limit, build commands and the roadmap. CONTRIBUTING, CODE_OF_CONDUCT (Contributor Covenant 2.1), SECURITY and CHANGELOG are new, and the copyright years in NOTICE.txt are updated.

Two things to check before merging. SECURITY.md and CODE_OF_CONDUCT.md name GitHub private vulnerability reporting as the only contact, so it has to be enabled in the repository settings. The CHANGELOG also records that the 0.5.5 entry in changes.xml was never tagged or published, and that 0.5.3 is tagged but not on Maven Central.

Rewrite the README for the current state of the project and add
CONTRIBUTING, CODE_OF_CONDUCT, SECURITY and CHANGELOG, so the repository
has the standard files for the 0.6.0 release. Update the copyright years
in NOTICE.txt.
@szkiba
szkiba merged commit 074f32e into main Nov 17, 2026
1 check passed
@szkiba
szkiba deleted the docs-modernization branch November 17, 2026 07:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant