Skip to content

docs(readme): correct CI workflow list + add AGENTS.md - #22

Merged
Hidden-Node merged 2 commits into
mainfrom
advisor/010-readme-agents
Jul 20, 2026
Merged

docs(readme): correct CI workflow list + add AGENTS.md#22
Hidden-Node merged 2 commits into
mainfrom
advisor/010-readme-agents

Conversation

@Hidden-Node

Copy link
Copy Markdown
Owner

Problem

The README's "GitHub Workflows" section (README.md:309-326) made two false claims:

  1. References a non-existent release.yml workflow. The repo only has android-ci.yml and release-manual.ymlrelease.yml was deleted at some point but the README still listed it.

  2. Claims android-ci.yml "Checks code quality". It only builds the debug APK (and now runs unit tests after PR fix(android): VpnTileService dispatcher ordering + CI Go 1.25 alignment #17). No lint step exists.

Changes

README.md — replaced the entire "GitHub Workflows" subsection

  • android-ci.yml: Accurately describes trigger (push to main/master + PRs), AAR build, debug APK build, unit tests, artifact upload.
  • release-manual.yml: Describes workflow_dispatch inputs (tag_name, release_name, make_latest), signing secrets required, release asset upload via softprops/action-gh-release@v2.
  • Adds a blockquote at the end explaining there is no release.yml and how to perform tag-triggered releases.

AGENTS.md — new file (repo root)

Operating context for AI agents (opencode, Cursor, Claude Code, etc.):

  • What this repo is — project overview, upstream links
  • Architecture — layered diagram (UI → ViewModels → VPN Service/Go Core → Network)
  • How to build — AAR, debug APK, release AAB
  • How to verify — unit tests, lint, compile check, go vet/gofmt
  • Conventions — Kotlin (Hilt, coroutines, error handling, logging) and Go (mutex discipline, error wrapping)
  • Things that are easy to get wrong — credentials in logs, destructive Room migrations, engine.Stop() panics, cleartext network_security_config.xml, stale Go mobile AAR
  • Running the plans in plans/ — references the plans/ directory index

Eliminates redundant recon work for future agent-assisted development sessions.

Replace the stale GitHub Workflows subsection. Drop the non-existent release.yml reference, drop the false "Checks code quality" claim, and accurately describe android-ci.yml and release-manual.yml.
Operating context for AI agents: project overview, architecture, build/verify commands, Kotlin/Go conventions, and common footguns.
@Hidden-Node
Hidden-Node merged commit 737c9c3 into main Jul 20, 2026
1 check failed
@Hidden-Node
Hidden-Node deleted the advisor/010-readme-agents branch July 20, 2026 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant