docs: add user manual for CLA signing system#454
Conversation
Add Chinese and English user manuals covering all roles (community manager, corp admin, employee manager, contributor) with step-by-step API examples and FAQ. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Welcome To opensourceways CommunityHey @JavaPythonAIForBAT , thanks for your contribution to the community. Bot Usage ManualI'm the Bot here serving you. You can find the instructions on how to interact with me at Here . That means you can comment below every pull request or issue to trigger Bot Commands. Contact GuideIf you have any questions, please contact the SIG: infratructure , |
CLA Signature PassJavaPythonAIForBAT, thanks for your pull request. All authors of the commits have signed the CLA. 👍 |
Linking Issue Notice@JavaPythonAIForBAT , the pull request must be linked to at least one issue. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds comprehensive user manuals in English and Chinese for the CLA system, detailing roles, onboarding flows, and API operations. Feedback was provided to correct the documentation regarding API request formats: the POST /v1/link/ endpoint expects form data instead of JSON, and the link_id field is redundant in the request body for template uploads as it is already a path parameter.
| Send a request to `POST /v1/link/` with the following body: | ||
|
|
||
| ```json | ||
| { | ||
| "platform": "github", | ||
| "org_id": "your-org-name", | ||
| "repo_id": "", | ||
| "org_alias": "Your Org Display Name", | ||
| "org_logo": "https://example.com/logo.png", | ||
| "project_url": "https://github.com/your-org" | ||
| } | ||
| ``` |
There was a problem hiding this comment.
The LinkController.Link implementation uses fetchInputPayloadFromFormData, which indicates that the API expects form data (either application/x-www-form-urlencoded or multipart/form-data) rather than a JSON request body. Please update the example to reflect the correct content type and format.
| Send a request to `POST /v1/link/` with the following body: | |
| ```json | |
| { | |
| "platform": "github", | |
| "org_id": "your-org-name", | |
| "repo_id": "", | |
| "org_alias": "Your Org Display Name", | |
| "org_logo": "https://example.com/logo.png", | |
| "project_url": "https://github.com/your-org" | |
| } | |
| ``` | |
| Send a request to POST /v1/link/ (Content-Type: application/x-www-form-urlencoded) with the following parameters: | |
| platform: github | |
| org_id: your-org-name | |
| repo_id: "" | |
| org_alias: Your Org Display Name | |
| org_logo: https://example.com/logo.png | |
| project_url: https://github.com/your-org |
| link_id: <link_id from previous step> | ||
| apply_to: individual (or corporation) |
There was a problem hiding this comment.
The link_id is already specified as a path parameter in the URL (/v1/cla/:link_id). It is redundant to include it in the form data body.
| link_id: <link_id from previous step> | |
| apply_to: individual (or corporation) | |
| apply_to: individual (or corporation) |
| 向 `POST /v1/link/` 发送请求，携带以下参数： | ||
|
|
||
| ```json | ||
| { | ||
| "platform": "github", | ||
| "org_id": "your-org-name", | ||
| "repo_id": "", | ||
| "org_alias": "Your Org Display Name", | ||
| "org_logo": "https://example.com/logo.png", | ||
| "project_url": "https://github.com/your-org" | ||
| } | ||
| ``` |
There was a problem hiding this comment.
后端 LinkController.Link 使用了 fetchInputPayloadFromFormData，这表明该接口期望接收表单数据（application/x-www-form-urlencoded 或 multipart/form-data），而不是 JSON 请求体。请更新示例以符合实际的接口要求。
| 向 `POST /v1/link/` 发送请求，携带以下参数： | |
| ```json | |
| { | |
| "platform": "github", | |
| "org_id": "your-org-name", | |
| "repo_id": "", | |
| "org_alias": "Your Org Display Name", | |
| "org_logo": "https://example.com/logo.png", | |
| "project_url": "https://github.com/your-org" | |
| } | |
| ``` | |
| 向 POST /v1/link/ 发送请求 (Content-Type: application/x-www-form-urlencoded)，携带以下参数： | |
| platform: github | |
| org_id: your-org-name | |
| repo_id: "" | |
| org_alias: Your Org Display Name | |
| org_logo: https://example.com/logo.png | |
| project_url: https://github.com/your-org |
| link_id: <上一步获取的 link_id> | ||
| apply_to: individual （或 corporation） |
There was a problem hiding this comment.
link_id 已经作为路径参数包含在 URL 中（/v1/cla/:link_id），在表单正文中再次包含它是多余的。
| link_id: <上一步获取的 link_id> | |
| apply_to: individual （或 corporation） | |
| apply_to: individual （或 corporation） |
|
|||||||||||||||||||
2 participants
Summary
user-manual-cla-zh.md: Chinese user manualuser-manual-cla-en.md: English user manualBoth manuals cover all roles (community manager, corp admin, employee manager, contributor) with ASCII onboarding flowchart, three-part step format (what you do / what we do / how to verify), step-by-step API examples, and FAQ.
Test plan
🤖 Generated with Claude Code