docs: add readme, changelog, security policy, and agent instructions - #2
Merged
Merged
Conversation
Why The phase 1 merge deleted every markdown file in the repository, so nothing described the code that actually shipped: no install steps, no version history, no vulnerability-reporting process, no rules for an AI agent working here. What changed README and SECURITY point installation, releases, and vulnerability reports at the public devops-infinity/ownpg-releases repository, since this repository stays private. CHANGELOG lists the current Unreleased capabilities against the real command surface, not the two commit messages already on main. AGENTS.md and CLAUDE.md carry identical text describing the two-crate layout and the CI-enforced conventions, matching the pairing the project used before deletion. Risk None. Docs only, no code or CI change.
Code Review by Qodo🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)
Great, no issues found!Qodo reviewed your code and found no material issues that require reviewTip of the day💡 Did you know, you can start a comment with 'qodo' or '@qodo' to chat about any finding |
PR Summary by QodoAdd baseline project, security, and agent documentation
AI Description
Diagram
High-Level Assessment
Files changed (5)
|
17 tasks
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.
Summary
Adds README, CHANGELOG, SECURITY, and matching CLAUDE.md/AGENTS.md files, since the phase 1
merge left the repository with no documentation describing the code that shipped.
Motivation
main had no README, changelog, security policy, or agent instructions after the phase 1 merge
deleted every markdown file. A private repository with no README still needs one for anyone
with access, and the public devops-infinity/ownpg-releases repository already needed an
accurate description of the private source it distributes.
Changes
README.md: what OwnPG does, its pre-release status, install and quick-start commands,the configuration order, and the tool groups, each checked against the actual CLI and config
source.
CHANGELOG.md: an Unreleased section listing the current command surface andcapabilities, since no version is tagged.
SECURITY.md: points a vulnerability report at GitHub's private vulnerabilityreporting on devops-infinity/ownpg-releases, since this repository is private and a reporter
cannot open an issue here.
AGENTS.mdandCLAUDE.md, identical text: the two-crate layout, the CI-enforcedconventions (
cargo fmt,cargo clippy -D warnings, the coverage floor, the banned-cratelist), and a do/don't list tied to those checks.
Type of Change
feat)fix)refactor)docs)perf)test)build/ci)chore)!to type)Testing
Test type:
Steps to verify:
rgacross all five files for an em dash, the CI house-rules wording pattern, a markdowntable, and emoji: zero hits.
github.com/SHSharkar) fetched directly: HTTP 200.
diff AGENTS.md CLAUDE.md: identical.Checklist
Additional Context
GitHub's private vulnerability reporting was off on devops-infinity/ownpg-releases despite its
own SECURITY.md already pointing there. It is now enabled, so the link this PR adds actually
works.