-
Notifications
You must be signed in to change notification settings - Fork 0
chore: update repo compliance with AGENTS.md (lint, format, ci) #10
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,4 @@ | ||
| #!/usr/bin/env sh | ||
| set -eu | ||
|
|
||
| npm run lint | ||
| npm run test | ||
| npm run build | ||
| npm run verify |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,19 @@ | ||
| ## Summary | ||
|
|
||
| Describe the change and why it is needed. | ||
|
|
||
| ## Changes | ||
| - | ||
|
|
||
| - | ||
|
|
||
| ## Testing | ||
|
|
||
| - [ ] npm run lint | ||
| - [ ] npm test | ||
| - [ ] npm pack --dry-run (if publishing-related) | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] README.md updated or not needed (explain why) | ||
| - [ ] No generated artifacts committed | ||
| - [ ] Changes are scoped to the affected repository only | ||
| - [ ] Changes are scoped to the affected repository only |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| dist/ | ||
| coverage/ | ||
| node_modules/ | ||
| AGENTS.md | ||
| package-lock.json |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "singleQuote": true, | ||
| "trailingComma": "all", | ||
| "tabWidth": 2, | ||
| "semi": true, | ||
| "printWidth": 100 | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,25 @@ | ||
| # Code of Conduct | ||
|
|
||
| ## Our pledge | ||
|
|
||
| We are committed to providing a friendly, safe, and welcoming environment for everyone. | ||
|
|
||
| ## Expected behavior | ||
|
|
||
| - Be respectful and considerate. | ||
| - Assume good intent and collaborate constructively. | ||
| - Provide and accept feedback gracefully. | ||
|
|
||
| ## Unacceptable behavior | ||
|
|
||
| - Harassment, discrimination, or hateful conduct. | ||
| - Personal attacks, trolling, or intimidation. | ||
| - Publishing private information without permission. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Maintainers may remove, edit, or reject contributions that violate this Code of Conduct. | ||
|
|
||
| ## Reporting | ||
| Report issues to the maintainers via GitHub Security Advisories or a private channel when possible. | ||
|
|
||
| Report issues to the maintainers via GitHub Security Advisories or a private channel when possible. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -90,10 +90,10 @@ Ruleset files accept JSON with `//` or `/* */` comments. | |
| // Optional Claude Code companion output. | ||
| "claude": { | ||
| "enabled": true, | ||
| "output": "CLAUDE.md" | ||
| "output": "CLAUDE.md", | ||
| }, | ||
| // Output file name. | ||
| "output": "AGENTS.md" | ||
| "output": "AGENTS.md", | ||
| } | ||
|
Comment on lines
+93
to
97
|
||
| ``` | ||
|
|
||
|
|
@@ -147,11 +147,12 @@ npm install | |
| npm run lint | ||
| npm run build | ||
| npm test | ||
| ``` | ||
|
|
||
| ## Overview | ||
| This repository contains the compose-agentsmd project. | ||
|
|
||
| ## Requirements and Configuration | ||
| - No required environment variables are documented. | ||
|
|
||
| ``` | ||
|
|
||
| ## Overview | ||
|
|
||
| This repository contains the compose-agentsmd project. | ||
|
|
||
| ## Requirements and Configuration | ||
|
|
||
| - No required environment variables are documented. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,18 @@ | ||
| # Security Policy | ||
|
|
||
| ## Supported versions | ||
|
|
||
| The latest published version is supported. | ||
|
|
||
| ## Reporting a vulnerability | ||
|
|
||
| Please report vulnerabilities privately via GitHub Security Advisories or by opening a private report to the maintainers. Do not file public issues for security-sensitive reports. | ||
|
|
||
| When reporting, include: | ||
|
|
||
| - A clear description of the vulnerability | ||
| - Steps to reproduce or a proof of concept | ||
| - Impact assessment | ||
| - Suggested mitigations (if known) | ||
|
|
||
| We will acknowledge receipt and work on a fix as quickly as possible. | ||
| We will acknowledge receipt and work on a fix as quickly as possible. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Distribution and release | ||
|
|
||
| - After publishing this repository, update the globally installed CLI to the latest version. | ||
| - After publishing this repository, update the globally installed CLI to the latest version. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,6 @@ | ||
| { | ||
| { | ||
| "source": "github:metyatech/agent-rules", | ||
| "domains": [ | ||
| "cli", | ||
| "node", | ||
| "release" | ||
| ], | ||
| "extra": [ | ||
| "agent-rules-local/compose-agentsmd-local.md" | ||
| ], | ||
| "domains": ["cli", "node", "release"], | ||
| "extra": ["agent-rules-local/compose-agentsmd-local.md"], | ||
| "output": "AGENTS.md" | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| import eslint from '@eslint/js'; | ||
| import tseslint from 'typescript-eslint'; | ||
| import prettierConfig from 'eslint-config-prettier'; | ||
| import globals from 'globals'; | ||
|
|
||
| export default tseslint.config( | ||
| eslint.configs.recommended, | ||
| ...tseslint.configs.recommended, | ||
| prettierConfig, | ||
| { | ||
| languageOptions: { | ||
| globals: { | ||
| ...globals.node, | ||
| }, | ||
| parserOptions: { | ||
| projectService: { | ||
| allowDefaultProject: ['*.js', '*.mjs', 'test/*.js'], | ||
| }, | ||
| tsconfigRootDir: import.meta.dirname, | ||
| }, | ||
|
Comment on lines
+16
to
+20
|
||
| }, | ||
| }, | ||
| { | ||
| ignores: ['dist/', 'coverage/', 'AGENTS.md', 'tools/'], | ||
| }, | ||
| ); | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CI uses node-version '20', but the updated devDependencies (ESLint v10 and related packages) require newer Node minors according to their engines constraints. This can cause npm ci / npm run lint to fail depending on which 20.x runner version GitHub Actions resolves. Pin CI to a Node version that satisfies the toolchain’s minimum (or adjust dependency versions/engines so Node '20' remains valid).