A self-organizing Obsidian vault that gives AI coding agents persistent memory.
TypeScript ai-agentsclaude-codecodex-cligemini-cliknowledge-managementobsidianobsidian-vaultpersistent-memorysecond-braintemplate
docs: take code contributions through assignment, and close unassigned PRs without review (#369)
Brenno Ferrarif151a94e8afe
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.mdindex 030f23f..7c76645 100644--- a/.github/pull_request_template.md+++ b/.github/pull_request_template.md@@ -20,6 +20,8 @@## Checklist- [ ] PR title follows `type: description` format+- [ ] Links an issue assigned to me, or is a trivial typo fix in documentation+- [ ] A code change comes with a test that fails on `main` and passes with it- [ ] Tests pass (`cd .claude/scripts && npm test`)- [ ] Any NEW guard, check, or config constraint has demonstrated a red — broken deliberately, seen to fire, reverted. Say which, in one line- [ ] Doc tables updated if adding commands/agents (AGENTS.md, README, Skills.md, translations)diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 00c02b7..37bdd07 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -4,40 +4,40 @@ Thanks for your interest in contributing to obsidian-mind!## Quick Start-1. Pick an issue labelled `help wanted` or `good first issue` (see [Picking up an issue](#picking-up-an-issue)), or open one for what you have in mind-2. Comment on the issue that you're taking it, then fork the repo and create a branch from `main`-3. Make your changes-4. Open a PR with a title following the [commit format](#pr-title-format)-5. The maintainer will review, then merge, request changes, or close with context+Issues and bug reports are welcome from anyone. Code contributions go through assignment:-## Before You Open a PR+1. Find or open an issue, and comment on it that you'd like to work on it+2. Wait for the maintainer to assign it to you (an issue is assigned when it fits the project's plans)+3. Fork the repo and create a branch from `main`+4. Make your changes. A code change comes with a test that fails on `main` and passes with it+5. Open a PR with a title following the [commit format](#pr-title-format), linking the issue+6. Once CI is green and, for a code change, the PR shows that test, the maintainer reviews it, then merges, requests changes, or closes it with context++A PR for an issue that isn't assigned to you is closed without review. Trivial typo fixes in documentation are the only exception.-**Small changes can go straight to PR.** Typos, fixes, one-file updates, doc corrections. Just open it.+## Before You Open a PR-**Bigger changes should start with an issue.** This includes:+**Small fixes need an assigned issue too.** For bigger changes, agree the approach on the issue before writing code, such as:- Rewrites, migrations, or language swaps- New commands, agents, hooks, or vault structure- Anything that touches the install story or runtime requirements- Anything listed as self-owned in the [Roadmap](README.md#roadmap) section of the README-Some areas have ongoing work that isn't public yet. Opening an issue first lets us check whether the direction is already on the roadmap before you write code. Saves you from building something that can't be merged.+Some areas have ongoing work that isn't public yet, so the issue is where we check the direction against the roadmap. Saves you from building something that can't be merged.## Picking up an issue-Every open issue tells you whether it's open for contributions:+An issue's assignee is the one person whose PR for it gets reviewed.| Label | What it means ||---|---|-| `good first issue` | Small and self-contained. A good way in. |-| `help wanted` | Self-contained, with the problem, the cause and how to test the fix written in the issue. Go for it. |-| `maintainer` | Sequenced or cross-cutting work the maintainer is building, usually because other changes depend on it or it changes something every session relies on. Please don't open a PR for these. If you want to help, comment on the issue. |+| `maintainer` | Work the maintainer is building or sequencing. Please don't open a PR for these. If you'd like to help, ask on the issue. || `decision` | The deliverable is a ruling, not code. See [below](#some-issues-are-questions-and-they-close-differently). |-| no label | Not triaged yet. Ask on the issue before starting. |A few things that save everyone time:-- **Say you're on it.** Leave a one-line comment before you start, so two people don't build the same fix.+- **Ask to be assigned, then wait.** Comment on the issue before you start. The assignment means two people don't build the same fix, and that the fix is wanted.- **Build what the issue says.** Many issues here carry measurements, decisions and an explicit scope. If you think part of it is wrong, say so on the issue first; the issue gets updated before the code changes.- **Move text as written, don't rewrite it.** When an issue says content moves between files (for example out of an instruction file), carry it over unchanged. Summarising or shortening it along the way drops rules that agents rely on, even when the result reads fine.- **Tick only what you ran.** The PR checklist is read literally. If you couldn't run something, leave the box unticked and say why. That's fine, and far more useful than a tick.@@ -118,6 +118,8 @@ The release pipeline handles these automatically — **do not include in your PR## Before Submitting- [ ] PR title follows `type: description` format+- [ ] Links an issue assigned to you, or is a trivial typo fix in documentation+- [ ] A code change comes with a test that fails on `main` and passes with it- [ ] Counts match everywhere (commands, agents) if you added/removed any- [ ] New command/agent appears in ALL doc tables (README + Skills.md, and `.claude/rules/subagents.md` for an agent)- [ ] Translations flagged if you changed README.md (maintainer can handle these)@@ -165,4 +167,4 @@ A self-test that does not exit 0 means the gate is broken: fix it before trustin## Questions?-Open an issue or start a discussion. For small changes, PRs are welcome directly. For anything bigger, see [Before You Open a PR](#before-you-open-a-pr), and check the issue's label first ([Picking up an issue](#picking-up-an-issue)).+Open an issue or start a discussion. To contribute code, see [Quick Start](#quick-start).diff --git a/README.ja.md b/README.ja.mdindex d9add3a..d1caffc 100644--- a/README.ja.md+++ b/README.ja.md@@ -589,7 +589,7 @@ cd ~/new-vault && claude # または codex、gemini## 🗺️ ロードマップ-**コントリビューションは歓迎です。** 1ファイルを超える変更については、まずIssueを開いてください。特にフック、インストール手順、必要な環境に関わる変更については必須です。マージできないものを作る手間を省けます。+**Issue とバグ報告を歓迎します。** コードのコントリビューションはアサイン制です。Issue にコメントして担当を申し出て、アサインされてから PR を開いてください。あなたにアサインされていない Issue への PR はレビューせずにクローズします。詳しくは [CONTRIBUTING.md](CONTRIBUTING.md) を参照してください。---diff --git a/README.ko.md b/README.ko.mdindex 42f82d7..c0db445 100644--- a/README.ko.md+++ b/README.ko.md@@ -589,7 +589,7 @@ cd ~/new-vault && claude # 또는 codex, gemini## 🗺️ 로드맵-**기여는 환영합니다.** 파일 하나를 초과하는 변경 사항은 먼저 이슈를 열어 주세요. 특히 훅, 설치, 또는 설치에 필요한 요구 사항에 관련된 변경은 필수입니다. 머지할 수 없는 것을 만드는 수고를 덜 수 있습니다.+**이슈와 버그 보고를 환영합니다.** 코드 기여는 할당제로 진행됩니다. 이슈에 댓글로 작업 의사를 밝히고, 할당된 뒤에 PR을 열어 주세요. 본인에게 할당되지 않은 이슈에 대한 PR은 리뷰 없이 닫힙니다. 자세한 내용은 [CONTRIBUTING.md](CONTRIBUTING.md)를 참고하세요.---diff --git a/README.md b/README.mdindex d769606..cbdce86 100644--- a/README.md+++ b/README.md@@ -712,7 +712,7 @@ Your old vault is **never modified**. Use `--dry-run` to preview the plan withou## 🗺️ Roadmap-**Contributions welcome.** Open an issue first for anything bigger than a one-file change. Especially anything that touches the hooks, the install, or what people need installed. Saves you from building something that can't be merged.+**Issues and bug reports welcome.** Code contributions go through assignment: comment on an issue to ask for it, and open a PR once it's assigned to you. A PR for an issue not assigned to you is closed without review. See [CONTRIBUTING.md](CONTRIBUTING.md).---diff --git a/README.zh-CN.md b/README.zh-CN.mdindex 51da5a9..901ad8a 100644--- a/README.zh-CN.md+++ b/README.zh-CN.md@@ -589,7 +589,7 @@ Agent 将会:## 🗺️ 路线图-**欢迎贡献。** 对于超过单文件的改动,请先创建 Issue。特别是涉及 Hook、安装流程或运行环境要求的改动。可以避免你做出无法合并的工作。+**欢迎提交 Issue 和 Bug 报告。** 代码贡献采用指派制:在 Issue 下留言申请,被指派后再提交 PR。针对未指派给你的 Issue 的 PR 会不经审查直接关闭。详见 [CONTRIBUTING.md](CONTRIBUTING.md)。---