Skip to content

Commit 44c6ee6

Browse files
authored
chore(docs): rename ropy-contribution-flow skill to contribution-flow (#121)
Make the contribution-flow skill project-agnostic by removing ropy-specific references and updating all documentation links. Refs #120
1 parent 6552d66 commit 44c6ee6

4 files changed

Lines changed: 13 additions & 13 deletions

File tree

.agents/skills/ropy-contribution-flow/SKILL.md renamed to .agents/skills/contribution-flow/SKILL.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
2-
name: ropy-contribution-flow
3-
description: Ropy repository contribution workflow. Use for any code change that should become a commit — adding features, fixing bugs, refactoring, or any source modification. Drives the full Issue → Branch → PR → Merge process.
2+
name: contribution-flow
3+
description: Repository contribution workflow. Use for any code change that should become a commit — adding features, fixing bugs, refactoring, or any source modification. Drives the full Issue → Branch → PR → Merge process.
44
---
55

6-
# Ropy Contribution Flow
6+
# Contribution Flow
77

8-
Issue → Branch → PR → Merge workflow for any code change in this repo. Coding standards live in [`AGENTS.md`](../../../AGENTS.md); this skill only covers the process.
8+
Issue → Branch → PR → Merge workflow for any code change in this repo. Coding standards live in the project's development guidelines (e.g. `AGENTS.md`); this skill only covers the process.
99

1010
## Conventions
1111

1212
Shared vocabulary used throughout the flow below: `<type>` and `<scope>` placeholders in every step refer back here.
1313

1414
- **Types**: `feat | fix | docs | style | refactor | perf | test | build | ci | chore | revert`
15-
- **Scopes** (top-level modules): `gui | repository | clipboard | updater | i18n | config | gpui`
15+
- **Scopes**: infer from the project's top-level module/directory structure (e.g. `core`, `api`, `ui`).
1616
- **Subject**: lowercase, imperative mood, no trailing period.
1717
- **Consistency**: the `<type>` must match across the Issue title, branch prefix, every commit, and the PR title. The `<scope>` is required on commits and the PR title, optional on the Issue title, and omitted from the branch name.
1818

1919
## The flow
2020

2121
### 1. Open the Issue
2222

23-
Pick a template from `.github/ISSUE_TEMPLATE/`. Fill it into `/tmp/ropy-issue.md`, then:
23+
If the project has issue templates (`.github/ISSUE_TEMPLATE/`), pick the appropriate one. Otherwise use a concise description with acceptance criteria. Fill it into `/tmp/issue-body.md`, then:
2424

2525
```bash
26-
gh issue create --title "<type>: ..." --label "<from yml>" --body-file /tmp/ropy-issue.md
26+
gh issue create --title "<type>: ..." --label "<appropriate label>" --body-file /tmp/issue-body.md
2727
```
2828

2929
Capture the returned number as `<N>`.
@@ -39,7 +39,7 @@ git checkout -b <type>/<kebab-slug> # e.g. feat/grid-layout, fix/clipboard-empty
3939

4040
### 3. Implement
4141

42-
Follow `AGENTS.md`.
42+
Follow the project's development guidelines.
4343

4444
### 4. Precheck
4545

@@ -61,11 +61,11 @@ Multiple commits are fine — they are squashed on merge.
6161

6262
### 6. Push & Open the PR
6363

64-
Fill `.github/PULL_REQUEST_TEMPLATE.md` into `/tmp/ropy-pr.md`, then:
64+
If the project has a PR template (`.github/PULL_REQUEST_TEMPLATE.md`), fill it into `/tmp/pr-body.md`. Otherwise write a concise summary with a test plan. Then:
6565

6666
```bash
6767
git push -u origin HEAD
68-
gh pr create --base main --title "<type>(<scope>): ..." --body-file /tmp/ropy-pr.md
68+
gh pr create --base main --title "<type>(<scope>): ..." --body-file /tmp/pr-body.md
6969
```
7070

7171
Report the PR URL back to the user.

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@
1616

1717
## AI Collaboration Workflow
1818

19-
Any code change in this repository — by a human or an AI agent — MUST follow the contribution SOP defined in the [`ropy-contribution-flow`](./.agents/skills/ropy-contribution-flow/SKILL.md) skill.
19+
Any code change in this repository — by a human or an AI agent — MUST follow the contribution SOP defined in the [`contribution-flow`](./.agents/skills/contribution-flow/SKILL.md) skill.
2020

2121
That skill is the single source of truth for: when to open an Issue, branch naming, Conventional Commits rules, the `scripts/precheck.sh` gate, the `gh` command templates, and the PR self-check. Read it before making any commit.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ See the [Testing Documentation](./docs/TESTING.md) for guidelines on writing and
8282

8383
## Submitting Changes
8484

85-
Ropy follows an **Issue → Branch → PR → Squash Merge** workflow, executed via the local `gh` CLI. The complete, copy-paste-ready SOP lives in the [`ropy-contribution-flow`](./.claude/skills/ropy-contribution-flow/SKILL.md) skill — it is the single source of truth for branch naming, commit conventions, the `scripts/precheck.sh` gate, and the PR self-check. Both human and AI contributors should follow it.
85+
Ropy follows an **Issue → Branch → PR → Squash Merge** workflow, executed via the local `gh` CLI. The complete, copy-paste-ready SOP lives in the [`contribution-flow`](./.agents/skills/contribution-flow/SKILL.md) skill — it is the single source of truth for branch naming, commit conventions, the `scripts/precheck.sh` gate, and the PR self-check. Both human and AI contributors should follow it.
8686

8787
## Reporting Issues
8888

docs/CONTRIBUTING/CONTRIBUTING_ZH.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Ropy 支持多语言国际化(i18n)。语言文件同样使用 TOML 格式
6666

6767
## 提交规范
6868

69-
Ropy 采用 **Issue → 分支 → PR → Squash Merge** 的工作流,全程通过本地 `gh` CLI 完成。完整、可直接复制执行的 SOP 收敛在 [`ropy-contribution-flow`](../../.claude/skills/ropy-contribution-flow/SKILL.md) skill 中 —— 那里是分支命名、commit 规范、`scripts/precheck.sh` 检查、PR 自检清单的唯一权威来源。无论人类还是 AI 贡献者,都请遵循该 skill。
69+
Ropy 采用 **Issue → 分支 → PR → Squash Merge** 的工作流,全程通过本地 `gh` CLI 完成。完整、可直接复制执行的 SOP 收敛在 [`contribution-flow`](../../.agents/skills/contribution-flow/SKILL.md) skill 中 —— 那里是分支命名、commit 规范、`scripts/precheck.sh` 检查、PR 自检清单的唯一权威来源。无论人类还是 AI 贡献者,都请遵循该 skill。
7070

7171
## 问题反馈
7272

0 commit comments

Comments
 (0)