Repository navigation
docs: modernize README and add community files - #20
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.xmlwas never tagged or published, and that 0.5.3 is tagged but not on Maven Central.