GITHUB-SETUP.zh.md

GitHub 仓库设置建议

这个文件记录 stop-slop-zh 在 GitHub 上的推荐配置。部分配置不能通过仓库文件自动生效，需要维护者在 GitHub 页面手动设置。

About

建议填写：

• Description: Chinese LLM writing Skill for reducing predictable AI prose patterns without changing facts or author voice.
• Website: https://github.com/wdkang123/stop-slop-zh
• Topics:
  • chinese-writing
  • llm-skill
  • prompt-engineering
  • writing-style-guide
  • ai-writing
  • chinese-prose
  • claude-skill
  • chatgpt
  • cursor
  • codex
  • stop-slop

同样内容保存在 .github/REPOSITORY-METADATA.yml。

Features

建议开启：

• Issues
• Discussions
• Pull requests
• Wikis 关闭，避免维护分散
• Projects 可按需要开启

Branch Protection

建议给 main 设置保护：

• Require a pull request before merging
• Require status checks to pass before merging
• Required check: Validate docs
• Require branches to be up to date before merging
• Do not allow force pushes
• Do not allow deletions

如果只有一个维护者，可以暂时不要求审批，但仍建议保留 CI 检查。

Discussions

建议创建这些分类：

• Announcements：发布说明
• Usage：使用问题
• Rule ideas：尚不成熟的规则讨论
• Show and tell：使用案例
• Q&A：其他问题

.github/DISCUSSION_TEMPLATE/ 已提供基础模板。

Labels

建议按 .github/labels.yml 建立标签。GitHub 不会自动读取这个文件，它只是标准清单。

重点标签：

• skill
• references
• examples
• false-positive
• skill-behavior
• github-config
• release
• needs-triage

Actions

当前已有：

• Validate docs：检查 Skill 结构、必要文件、误伤条目、旧路径残留和尾随空白。
• Label pull requests：按文件路径给 PR 打标签。

Dependabot

.github/dependabot.yml 会每周检查 GitHub Actions 更新。

Release

建议每个重要版本都：

1. 更新 CHANGELOG.md。
2. 检查 SKILL.md 是否仍为短入口。
3. 确认 references 路径和 README 一致。
4. 确认 Validate docs 通过。
5. 创建 Git tag，例如 v0.2.0。
6. 在 GitHub Release 中说明新增规则、迁移路径和破坏性变更。