Skip to content

Commit ecafabc

Browse files
committed
docs: update contributed docs
Signed-off-by: yuluo-yx <yuluo08290126@gmail.com>
1 parent 2831000 commit ecafabc

File tree

4 files changed

+20
-6
lines changed

4 files changed

+20
-6
lines changed

CONTRIBUTION.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22

33
作为一个 Example 项目,我们希望您在提交代码时遵守以下规则:
44

5-
1. 提交的 Example 必须是完整的,包含必要的 README.md 和注释说明
6-
2. 在提交 PR 之后,自己阅览所提的 PR 确保没有基础问题,例如代码格式,错别字等
5+
1. 提交的 Example 必须是完整的,包含必要的 README.md **方法参数**注释说明
6+
2. 在提交 PR 之后,自己阅览所提的 PR 确保没有基础问题,例如代码格式,错别字,是否包含 **License Header**
77
3. 如果提交的 Example 需要使用到本地模型,可以使用 Docker/Docker Compose 等工具提供;
8-
4. 给每个 Example 选择合适的 module。
8+
4. 给每个 Example 选择合适的 module;
9+
5. 如果每个模型的 Example 示例都类似,可以不用拆分二级目录的模型名;
10+
6. 如果要在项目使用 json 序列化工具,推荐使用 jackson;
11+
7. 如果要在项目中使用工具类,推荐使用 Apache Common Utils 或者 Spring 相关工具类。
912

1013
## Spring AI Alibaba Example 的项目结构
1114

Roadmap-zh.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44

55
- [ ] Audio Example
66
- [ ] Image Example
7-
- [ ] Plugin Example
7+
- [ ] Vector Store Example
8+
- [ ] Function Calling Plugin Example
89
- [ ] RAG Example
910
- [X] Chat Example
1011
- [ ] Structured Example
1112
- [ ] Observability Example
12-
- [ ] Integration Example
13+
- [ ] Agent Example
1314
- [ ] Prompt Example
1415
- [ ] Multi Model Example
15-
- [ ] Function Example
1616

1717
除了上述 Example 项目之外,我们欢迎您贡献任何有用的 Example 项目。

spring-ai-alibaba-chat-example/openai/pom.xml

Whitespace-only changes.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
package com.alibaba.cloud.ai;
2+
3+
/**
4+
* @author yuluo
5+
* @author <a href="mailto:yuluo08290126@gmail.com">yuluo</a>
6+
*/
7+
public class Main {
8+
public static void main(String[] args) {
9+
System.out.println("Hello world!");
10+
}
11+
}

0 commit comments

Comments
 (0)