feat: compliance with AGENTS.md and standard project health files - #1
feat: compliance with AGENTS.md and standard project health files#1metyatech wants to merge 1 commit into
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
4062bb4 to
9c0a3c3
Compare
|
Updated PR with cleaner changes based on the latest main:
|
|
Agent runner idle failed. Repo: metyatech/skill-quality-workflow Summary: |
There was a problem hiding this comment.
Pull request overview
このPRは、リポジトリを AGENTS.md と一般的な “project health” ファイル群に準拠させ、開発/運用の標準化（ルール合成・lint/format・コミュニティ/セキュリティ文書）を整備するものです。
Changes:
AGENTS.md/agent-ruleset.jsonを追加してルール合成フローを導入package.json（lint/format/verify/compose）と関連ツールを追加CONTRIBUTING.md/SECURITY.md/CHANGELOG.mdなどの標準ドキュメントを追加し、README からリンク
Reviewed changes
Copilot reviewed 6 out of 11 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | lint/format/compose/verify スクリプトと開発用依存関係を追加 |
| package-lock.json | npm ロックファイルを追加して依存解決を固定化 |
| agent-ruleset.json | compose-agentsmd のルールソース/出力を設定 |
| AGENTS.md | compose-agentsmd により生成されたルール本文を追加 |
| .markdownlint.json | markdownlint のルール緩和設定を追加 |
| .gitignore | 生成物/ログ/ツール関連ディレクトリ等を除外 |
| CONTRIBUTING.md | 開発手順とPRフローを文書化 |
| SECURITY.md | セキュリティポリシー（報告方法/ガイドライン）を追加 |
| CHANGELOG.md | 変更履歴のフォーマットと初版エントリを追加 |
| README.md | 標準ファイルへのリンクとライセンス表記を更新 |
| CLAUDE.md | AGENTS.md 参照用のファイルを追加 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "compose-agentsmd": "latest", | ||
| "markdownlint-cli": "latest", | ||
| "prettier": "latest" |
There was a problem hiding this comment.
devDependencies are set to "latest", which makes installs non-reproducible across time and can unexpectedly change lint/format results. Pin these to exact versions (or a bounded semver range) and keep package-lock.json in sync.
| "compose-agentsmd": "latest", | |
| "markdownlint-cli": "latest", | |
| "prettier": "latest" | |
| "compose-agentsmd": "^1.0.0", | |
| "markdownlint-cli": "^0.41.0", | |
| "prettier": "^3.3.3" |
| }, | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, |
There was a problem hiding this comment.
If this package is intended to be published (it has a scoped name and publishConfig.access), add a files allowlist (and/or exports) to constrain what gets published. Otherwise the default publish set may include repo-only files like rules/docs and increase supply-chain/size risk.
| }, | |
| }, | |
| "files": [ | |
| "SKILL.md" | |
| ], |
| | Version | Supported | | ||
| | ------- | --------- | |
There was a problem hiding this comment.
Reporting vulnerabilities via public GitHub Issues can lead to accidental disclosure. Prefer a private reporting channel (GitHub Security Advisories/private vulnerability reporting, or a dedicated security email) and reference that here.
| cd skill-quality-workflow | ||
| ``` |
There was a problem hiding this comment.
Heading grammar: this section lists multiple prerequisites, so the heading should be plural.
| "version": "1.0.0", | ||
| "description": "An Agent Skill for test coverage methodology and defect handling workflows.", | ||
| "type": "module", | ||
| "main": "SKILL.md", |
There was a problem hiding this comment.
Several devDependencies in package-lock.json declare engines: { node: ">=20" }. Add an explicit engines.node (and optionally engineStrict guidance) in package.json so users on older Node versions fail fast with a clear message.
This PR brings the repository into compliance with AGENTS.md and project health standards.
Changes made:
Tests run: