Skip to content

Clarify README search discovery #23

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.

Sign up for GitHub

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

Merged
dd3ok merged 1 commit into from
Jun 10, 2026
Merged

Clarify README search discovery #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- Added wrapper help coverage for bundled validator options.
- Added package-shape smoke coverage and a runtime smoke matrix for manual
vendor runtime checks.
- Clarified README introductions and audience guidance for agent-skill discovery.

## [0.4.2] - 2026-06-10

Expand Down
6 changes: 5 additions & 1 deletion README.ko.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@

[English README](README.md)

`WATCHLIST.md`는 리포지토리 로컬 또는 개인 워치리스트 파일에 후속 확인 사항을 기록하기 위한 경량 **AI 에이전트 스킬(AI Agent Skill)**입니다. 이 스킬은 자율 스케줄러, 알림 서비스, 데몬, 데이터베이스, 크론 작업 또는 UI가 아닙니다. 대신 AI 에이전트 또는 사용자가 보류 중인 확인 사항을 기존 프로젝트 convention을 존중하는 일관된 Markdown 형식으로 남겨 놓치지 않도록 돕습니다.
`WATCHLIST.md`는 deferred check, 후속 확인, review-time task를 기록하기 위한 경량 **AI 에이전트 스킬(AI Agent Skill)**이자 AgentSkills 호환 Markdown workflow입니다. Codex, Claude Code, OpenClaw, Gemini CLI, Kilo, Hermes 같은 에이전트가 보류 중인 CI 결과, 배포, PR, 티켓, 작업, 데이터 동기화, 이메일 확인을 놓치지 않도록 돕습니다. 이 스킬은 자율 스케줄러, 자율 알림, scheduler, daemon, database, background worker로 동작하지 않습니다.

## Problem & Solution

**문제**: 긴 작업이나 여러 흐름이 겹치면 AI 에이전트가 나중에 확인해야 할 CI, 배포, 응답 대기 같은 항목을 놓치기 쉽습니다.

**해결책**: `WATCHLIST.md`는 후속 확인 사항을 선택된 리포지토리 로컬 또는 개인 워치리스트 파일에 구조화된 Markdown으로 기록합니다. 세션이 끝나도 컨텍스트가 남아, 다음 검토 때 이어서 확인할 수 있습니다.

## 누구를 위한 도구인가요?

AI agent workflow를 만들거나 운영하면서 scheduler, daemon, database, MCP server를 만들지 않고 deferred check, CI 후속 확인, 배포 검증, PR 확인, 티켓, 작업, 데이터 동기화, 이메일 후속 확인을 가벼운 Markdown 방식으로 추적해야 한다면 WATCHLIST.md가 맞습니다.

@gemini-code-assist gemini-code-assist Bot Jun 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrase WATCHLIST.md가 맞습니다 (literally "WATCHLIST.md is correct") sounds a bit colloquial and literal in Korean technical documentation. Using a more professional and natural term like WATCHLIST.md가 적합합니다 (is suitable) or WATCHLIST.md가 제격입니다 (is ideal) would better align with the formal tone used throughout the rest of the document.

Suggested change
AI agent workflow를 만들거나 운영하면서 scheduler, daemon, database, MCP server를 만들지 않고 deferred check, CI 후속 확인, 배포 검증, PR 확인, 티켓, 작업, 데이터 동기화, 이메일 후속 확인을 가벼운 Markdown 방식으로 추적해야 한다면 WATCHLIST.md가 맞습니다.
AI agent workflow를 만들거나 운영하면서 scheduler, daemon, database, MCP server를 만들지 않고 deferred check, CI 후속 확인, 배포 검증, PR 확인, 티켓, 작업, 데이터 동기화, 이메일 후속 확인을 가벼운 Markdown 방식으로 추적해야 한다면 WATCHLIST.md가 적합합니다.


## Quickstart

스킬 디렉토리를 설치합니다:
Expand Down
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@

[Korean README](README.ko.md)

`WATCHLIST.md` is a lightweight **AI Agent Skill** for recording deferred checks and follow-up checks in a repository-local or personal watchlist file. It supports Codex, Claude Code, and other AI agent workflows by writing pending follow-ups in a consistent Markdown format while respecting existing project conventions. It is not an autonomous scheduler, reminder service, daemon, database, cron job, or UI.
`WATCHLIST.md` is a lightweight **AI Agent Skill** and AgentSkills-compatible Markdown workflow for recording deferred checks, follow-up checks, and review-time tasks. It helps agents such as Codex, Claude Code, OpenClaw, Gemini CLI, Kilo, and Hermes track pending CI results, deployments, PRs, tickets, jobs, data syncs, and emails. It is not an autonomous scheduler, reminder service, daemon, database, cron job, UI, or background worker.

## Problem & Solution

**Problem**: During long-running work or overlapping task streams, AI agents can easily lose track of things that need to be checked later, such as CI, deployments, pending replies, or background jobs.

**Solution**: `WATCHLIST.md` records follow-up checks as structured Markdown in the selected repo-local or personal watchlist file. Context remains available after a session ends, so the next review can pick up where the previous one left off.

## Who Is This For?

Use WATCHLIST.md if you build or operate AI agent workflows and need a lightweight Markdown way to track deferred checks, CI follow-ups, deployment verification, PR checks, tickets, jobs, data syncs, or email follow-ups without creating a scheduler, daemon, database, or MCP server.

## Quickstart

Install the skill directory:
Expand Down
18 changes: 18 additions & 0 deletions evals/test_check_watchlist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,24 @@ def test_readme_documents_field_and_strict_safety_expectations(self):
self.assertIn("확인 전에는 보통 비워 둡니다", korean)
self.assertIn("`--strict-safety`는 의도적으로 보수적입니다", korean)

def test_readme_intro_and_audience_are_search_discoverable(self):
english = (REPO_ROOT / "README.md").read_text(encoding="utf-8")
korean = (REPO_ROOT / "README.ko.md").read_text(encoding="utf-8")

self.assertIn("AgentSkills-compatible Markdown workflow", english)
self.assertIn("Codex, Claude Code, OpenClaw, Gemini CLI, Kilo, and Hermes", english)
self.assertIn("not an autonomous scheduler", english)
self.assertIn("## Who Is This For?", english)
self.assertIn("CI follow-ups, deployment verification, PR checks", english)
self.assertIn("without creating a scheduler, daemon, database, or MCP server", english)

self.assertIn("AgentSkills 호환 Markdown workflow", korean)
self.assertIn("Codex, Claude Code, OpenClaw, Gemini CLI, Kilo, Hermes", korean)
self.assertIn("자율 알림", korean)
self.assertIn("## 누구를 위한 도구인가요?", korean)
self.assertIn("CI 후속 확인, 배포 검증, PR 확인", korean)
self.assertIn("scheduler, daemon, database, MCP server", korean)

def test_readme_documents_generated_file_policy(self):
english = (REPO_ROOT / "README.md").read_text(encoding="utf-8")
korean = (REPO_ROOT / "README.ko.md").read_text(encoding="utf-8")
Expand Down
Loading