Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 0 additions & 1 deletion AGENTS.md

This file was deleted.

180 changes: 180 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
# AGENTS.md

This file provides guidance to coding agents when working with code in this repository.

## Repository Overview

This is a personal inventory repository (plrom - People, Communities, Things) that maintains a curated list of favorite content creators, companies, tools, and products. The content is written in Chinese and synced to the personal blog (bokushi) via GitHub Actions when a release is published.

## Common Commands

### Link Checking

The repository uses linkspector to validate URLs in README.md:

```bash
# Check all links (runs automatically via GitHub Actions)
npx linkspector .
```

Configuration is in [.linkspector.yml](.linkspector.yml) which ignores certain domains that frequently timeout or block bots.

### 体量盘点 (FOMO Limits Dashboard)

[.github/scripts/audit.py](.github/scripts/audit.py) renders a single MECE-ish limits table inside `## 维护说明` between `<!-- AUDIT:START -->` / `<!-- AUDIT:END -->` sentinels. Each row shows a domain (e.g. 月订阅¥, 关注的人, AI 工具数), its current value, the user-set upper limit, and a status (留白 / 持平 / 超额).

**Limits 配置在 [audit/limits.toml](audit/limits.toml)**——这是单一权威源,编辑这里加/减/调上限。支持的 metric 见配置文件头部注释。

```bash
# Print full audit report (per-H3 detail) to stdout for deep dive
python3 .github/scripts/audit.py

# Refresh the inline AUDIT block in README based on limits.toml
python3 .github/scripts/audit.py --update README.md
```

The pre-commit hook (`.pre-commit-config.yaml`) auto-runs `--update` whenever README.md, audit.py, or limits.toml is staged. First-time setup on a fresh clone:

```bash
pre-commit install
```

If the hook modifies README.md, the commit fails — re-stage and re-commit.

## GitHub Actions Workflow

### Link Checker Workflow

[.github/workflows/check-links.yml](.github/workflows/check-links.yml):

- Validates all links in README.md on pushes and PRs

### Bokushi Sync Workflow

[.github/workflows/sync-to-bokushi.yml](.github/workflows/sync-to-bokushi.yml):

- **Trigger**: Release `published` events on this repository, or manual `workflow_dispatch`
- **Process**: Renders README metadata with [.github/scripts/sync_to_bokushi.py](.github/scripts/sync_to_bokushi.py), updates `niracler/bokushi`'s `src/content/blog/plrom.md`, and opens a PR via `peter-evans/create-pull-request`
- **Secret Required**: `BOKUSHI_SYNC_TOKEN` (Classic PAT with `repo` scope) so the workflow can push branches to `niracler/bokushi`

## Content Structure

The [README.md](README.md) is organized into three main sections:

1. **人 (People)**: Content creators categorized by type
- 技术博主 (Tech bloggers)
- 作家 (Writers)
- 漫画家 (Manga artists)
- 导演 (Directors)
- UP 主 & 油管主 (Video creators)
- 播客 (Podcasters)
- 歌手 & 音乐制作人 (Musicians)

2. **组织或社区 (Organizations/Communities)**
- 组织 (Organizations)
- 游戏 & 动画公司 (Game & animation companies)
- 技术新闻 (Tech news)

3. **物 (Things)**: Hardware, software, and tools
- 电脑及配件 (Computers & accessories)
- 软件工具 (Software tools)
- Various personal devices

## Editing Guidelines

When making changes to README.md:

1. **Preserve metadata structure**: Always keep the frontmatter format intact
2. **Update modified date**: Change the `modified:` field to current date when making content changes
3. **Maintain consistency**: Follow the existing format with emojis, links, and commentary style
4. **Use details tags**: Deprecated or sensitive content goes in `<details>` sections
5. **Test links**: Run link checking before committing to avoid broken URLs

## Development Workflow

### Update Cycle

This repository follows a **monthly update cycle**:

- **Frequency**: Once per month
- **Versioning**: `YYYY.MM` format (e.g., 2025.10, 2025.11)
- **Process**: Each monthly update gets a PR, version tag, and changelog entry

### Branch Naming

```text
feature/update-YYYY-MM # Monthly updates
feature/add-game-companies # Feature additions
fix/broken-links # Bug fixes
docs/update-guide # Documentation updates
```

### Monthly Update Process

1. **Create branch**: `git checkout -b feature/update-2025-10`

2. **Update content** in [README.md](README.md):
- Add new people/communities/things
- Remove items no longer followed
- Update `modified` date in frontmatter

3. **Update [CHANGELOG.md](CHANGELOG.md)**:

```markdown
## [2025.10] - 2025-10-21

### Added
- **[Name](link)** (category) - Reason for adding

### Removed
- **Name** (category) - Reason for removal
```

4. **Check links**: `npx linkspector .`

5. **Create PR**:

```bash
git add README.md CHANGELOG.md
git commit -m "feat: 2025年10月月度更新"
git push origin feature/update-2025-10
gh pr create --title "月度更新: 2025年10月"
```

6. **After merge, create release**:

```bash
git checkout main && git pull
git tag -a v2025.10 -m "2025.10"
git push origin v2025.10
```

### Commit Message Format

```text
feat: add new items or monthly update
fix: fix broken links or errors
docs: documentation updates
chore: releases, maintenance
```

### Versioning

- **Monthly releases**: `YYYY.MM` (e.g., v2025.10)
- **Hotfixes**: `YYYY.MM.PATCH` (e.g., v2025.10.1)

### Changelog Maintenance

[CHANGELOG.md](CHANGELOG.md) follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format with sections:

- **Added**: New people/communities/things with reasons
- **Removed**: Removed items with reasons
- **Changed**: Description or category updates
- **Fixed**: Link fixes, error corrections

Each entry should explain **why** the change was made, not just what changed.

## Technical Notes

- The repository contains **no traditional code** - it's purely content and automation
- Blog sync uses [sync_to_bokushi.py](.github/scripts/sync_to_bokushi.py) to render metadata and open a PR to `niracler/bokushi`
34 changes: 32 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,35 @@

## [Unreleased]

## [2026.08] - 2026-08-09
Comment thread
niracler marked this conversation as resolved.

### Added

- **[Skinat](https://skinat.world.tmall.com/shop/view_shop.htm)** (淘宝店主) - 朋友介绍的手机背膜和贴纸店,第一张背膜已经用了快一年半,现在是第二张,继续看看能不能真的贴满两年。
- **[Rhodia 法国罗地亚橙色头钉便笺本](https://detail.tmall.com/item.htm?id=655586417891)** (物 / 文具) - 公司里用来写草稿和画简笔画的便笺本。
- **[tomtoc T37 小型旅行斜挎包](https://detail.tmall.com/item.htm?id=1046059603933)** (物 / 包包) - 腰突手术后不能背重物,于是换成了一个只能装纸巾和充电宝的小包。
- **[IKEA UTESPELARE 游戏桌](https://www.ikea.com/jp/en/p/utespelare-gaming-desk-black-40500350/)** (物 / 桌椅) - 用了很多年的完美桌子,之前搬去西安,现在又跟着搬回来了。
- **[宜家 BASTBOLL 贝斯博尔电竞椅](https://item.jd.com/10166866497637.html)** (物 / 桌椅) - 因为腰突换掉旧椅子,虽然新椅子更舒服,但还是不能替代定时起身活动。
- **[爱乐普(eneloop)20 周年限量版 5 号充电电池](https://item.jd.com/100335655360.html)** (物 / 充电) - 主要给 Xbox 手柄使用,免得每次想玩游戏还要临时找电池。
- **[麦金獭手机钢化膜 AR 抗反射高清高覆盖](https://item.taobao.com/item.htm?abbucket=5&id=1039743168559)** (物 / 手机以及平板) - 当前使用的手机膜,先把链接记录下来,之后换膜时还能找得到。

### Changed

- **🤖 大模型工具** — 这次调整更像是对开发方式的一次反思:随着模型本身能力增强,很多原先用于开发流程的 Skill 已经不再必要。现在尽可能只保留工具类插件;具体开发流程先自己理解,再复述给 LLM,避免把代码交给无法控制的黑盒流程。
- **Codex** — 更新为 `$100/m, 公司付费`,并按当前实际配置重新整理插件、MCP 服务和辅助工具。
- **Cursor** — 更新过期列表中的说明,从「改用 VS Code + Claude Code」改为「改用 VS Code + Codex」。
- **订阅和音乐工具** — 将网易云音乐、`netease-cloud-music-dl`、Evermusic 和 Apple Music 移入过期列表,这些软件现在都已经不用了。
- **设备状态** — 更新 AirTag、Nintendo Switch 2、Apple TV 4K 和米家智能香氛机的当前使用情况。
- **仓库工作指南** — 将 `CLAUDE.md` 更名为 `AGENTS.md`,改为面向通用 coding agent 的说明。

### Removed

- **Claude Code、Anthropic News** → 移入过期或不再使用列表。
- **八九间 U5 人体工学电脑椅** → 移入不活跃列表,换成宜家 BASTBOLL 电竞椅。
- **忽左忽右、纵横四海、原来是这样 Dscience** → 移入播客不活跃列表,最近已经没怎么听了。
- **部分 Telegram 频道** → 移除不再关注或基本停止更新的频道。
- **Anki、simple-anki-sync** → 移入学习和 Obsidian 的过期列表,最近没有稳定使用和维护它们的时间。

## [2026.04] - 2026-04-29

### Added
Expand All @@ -33,7 +62,7 @@

### Added

- **[Nintendo Switch 2](https://www.nintendo.com/us/gaming-systems/nintendo-switch-2/)** (游戏娱乐设备) - 过年前入手,主力在玩 Pokopia
- **[Nintendo Switch 2](https://www.nintendo.com/gaming-systems/switch-2/)** (游戏娱乐设备) - 过年前入手,主力在玩 Pokopia
- **[Apifox](https://apifox.com/)** (软件 / 开发工具) - 工作中用于 API 调试
- **[Keka](https://apps.apple.com/us/app/keka/id470158793?mt=12)** (软件 / 生产力工具) - macOS 解压缩工具

Expand Down Expand Up @@ -177,7 +206,8 @@
- 添加 GitHub Actions 链接检查
- 规范化版本发布流程(PR + Tag + Release)

[Unreleased]: https://github.com/niracler/plrom/compare/v2026.02...HEAD
[Unreleased]: https://github.com/niracler/plrom/compare/v2026.08...HEAD
[2026.08]: https://github.com/niracler/plrom/compare/v2026.04...v2026.08
[2026.02]: https://github.com/niracler/plrom/compare/v2026.01...v2026.02
[2026.01]: https://github.com/niracler/plrom/compare/v2025.12...v2026.01
[2025.12]: https://github.com/niracler/plrom/compare/v2025.11...v2025.12
Expand Down
Loading
Loading