Skip to content

Commit c95019a

Browse files
committed
docs(contributing): 贡献者工作流成文——Issue → Claim → PR
z2Ace0107 在 #180 的认领流程跑通了,把实践固化为文档:fixes/小功能也 一律 issue 先行;认领评论报备计划、方向性问题在认领线程先定;一 issue 一 PR(Closes/Fixes 引用);PR 只动 src/+test/ 并随带 npm run sync 与 README 行;CI 绿才进 review。直推 main 明确为维护者专属捷径。
1 parent eaaec77 commit c95019a

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

‎CONTRIBUTING.md‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,23 @@ Common scripts (all run under `dsh-mneme/`):
9898
```
9999

100100
- Run `npm test` before committing and confirm green (note any environment-only known exceptions in the commit message).
101-
- **Small fixes**: can push straight to `main` (this is the project's workflow).
101+
- **Small fixes**: maintainers can push straight to `main` (maintainers-only shortcut — contributors always go through the workflow below).
102102
- **Larger features / breaking changes**: open an Issue first to state the motivation and design, then submit a PR — the PR triggers CI (Node 24 + full suite + Codecov).
103103
- Release operations (version bumps, tags, Releases, npm publish) are performed by maintainers — see the next section.
104104

105105
---
106106

107+
## Contributor Workflow: Issue → Claim → PR
108+
109+
Almost every change — **fixes and small features included** — starts from an Issue. Actionable work is labelled `good first issue` / `help wanted`.
110+
111+
1. **Claim before you start**: comment on the Issue with a short plan (what you will change, which files/tests). If the approach has open questions (path conventions, response shapes), settle them in that thread first — maintainer feedback on the claim is the fastest way to a merged PR. Opening a PR with no related Issue will be closed as unexpected (exceptions: typos and pure docs fixes).
112+
2. **One PR per Issue**: reference it in the PR body (`Closes #N` / `Fixes #N` when the PR fully resolves it).
113+
3. **Keep the PR minimal**: behavior changes belong in `src/` (+ `test/`); run `npm run sync` so `lib/` follows (`check-sync` will fail CI otherwise); `npm test` green; user-visible changes include their README line in the same PR.
114+
4. **CI must be green** (Node 22/24 × Linux/Windows, full suite, Codecov) before review.
115+
116+
---
117+
107118
## Scope: Platform Adaptation & Wrapper PRs
108119

109120
DSH upstream is still in developer preview — APIs and service interfaces change frequently. Until DSH reaches a stable release (RC or GA), **PRs that adapt dsh-mneme to secondary platforms or wrap it into other hosts are not a priority** and are reviewed with extra caution:

0 commit comments

Comments
 (0)