You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Copyright 2024-2026 the original author or authors.
2
+
#
3
+
# Licensed under the Apache License, Version 2.0 (the "License");
4
+
# you may not use this file except in compliance with the License.
5
+
# You may obtain a copy of the License at
6
+
#
7
+
# https://www.apache.org/licenses/LICENSE-2.0
8
+
#
9
+
# Unless required by applicable law or agreed to in writing, software
10
+
# distributed under the License is distributed on an "AS IS" BASIS,
11
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+
# See the License for the specific language governing permissions and
13
+
# limitations under the License.
14
+
name: Greetings
15
+
on: [pull_request]
16
+
jobs:
17
+
greeting:
18
+
runs-on: ubuntu-latest
19
+
permissions:
20
+
pull-requests: write
21
+
contents: read
22
+
steps:
23
+
- uses: actions/first-interaction@v1
24
+
with:
25
+
repo-token: ${{ secrets.GITHUB_TOKEN }}
26
+
issue-message: |
27
+
# Message with markdown.
28
+
This is the message that will be displayed on users' first issue.
29
+
pr-message: |-
30
+
🎉 Congratulations, @${{ github.actor }}, on your inaugural contribution to the Spring AI Alibaba repository! Your efforts are sincerely appreciated.
31
+
32
+
To maintain the integrity and legibility of our codebase, we kindly request that you verify your code adheres to the established project formatting standards prior to merging. Typically, comprehensive guidelines regarding code style and recommended formatting utilities can be found within the CONTRIBUTING.md file located in the repository.
33
+
34
+
Should you encounter any queries or require clarification, please do not hesitate to raise them. We extend our gratitude once more for your valuable contribution!
# Copyright 2024-2026 the original author or authors.
2
+
#
3
+
# Licensed under the Apache License, Version 2.0 (the "License");
4
+
# you may not use this file except in compliance with the License.
5
+
# You may obtain a copy of the License at
6
+
#
7
+
# https://www.apache.org/licenses/LICENSE-2.0
8
+
#
9
+
# Unless required by applicable law or agreed to in writing, software
10
+
# distributed under the License is distributed on an "AS IS" BASIS,
11
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+
# See the License for the specific language governing permissions and
13
+
# limitations under the License.
14
+
name: "Close Invalid Issue"
15
+
on:
16
+
schedule:
17
+
- cron: "0 0,8,16 * * *"
18
+
permissions:
19
+
contents: read
20
+
jobs:
21
+
stale:
22
+
permissions:
23
+
issues: write
24
+
runs-on: ubuntu-latest
25
+
env:
26
+
ACTIONS_STEP_DEBUG: true
27
+
steps:
28
+
- name: Close Stale Issues
29
+
uses: actions/stale@v6
30
+
with:
31
+
repo-token: ${{ secrets.GITHUB_TOKEN }}
32
+
stale-issue-message: "This issue has been marked as invalid question, please give more information by following the `issue` template. The issue will be closed in 1 days if no further activity occurs."
days-before-close: 30# Since adding 'stale' will update the PR, days-before-close is relative to that.
47
+
stale-pr-label: 'stale'
48
+
stale-pr-message: "This PR is being marked as stale since it has not had any activity in 90 days. If you\nwould like to keep this PR alive, please leave a comment asking for a review. If the PR has \nmerge conflicts, update it with the latest from the base branch.\n<p>\nIf you are having difficulty finding a reviewer, please reach out on the \n[committer list](COMMITTERS.md).\n<p>\nIf this PR is no longer valid or desired, please feel free to close it. If no activity\noccurs in the next 30 days, it will be automatically closed.\n"
49
+
close-pr-label: 'closed-stale'
50
+
close-pr-message: "This PR has been closed since it has not had any activity in 120 days. If you feel like this\nwas a mistake, or you would like to continue working on it, please feel free to re-open the \nPR and ask for a review."
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-1Lines changed: 21 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,10 +47,30 @@ After forking the repository, new commits may have appeared in the original repo
47
47
48
48
As one of the implementations of Spring AI, Spring AI Alibaba directly follows the Spring AI project's code standards. Before you start, please refer to the relevant code format specification instructions. You need to configure the code format standards properly before submitting your code.
49
49
50
-
### Develop, Commit, and Push
50
+
### Develop
51
51
52
52
Develop your feature, and **after development, we recommend using the `mvn clean package` command to ensure that the modified code can be compiled locally. This command will also automatically format the code in the Spring way**. Then commit your code. Before committing, please create a new branch related to this feature and use this branch for code submission.
53
53
54
+
### Development
55
+
56
+
Develop your feature, and **after completing development, it's recommended to use the `mvn clean package` command to ensure that the modified code compiles successfully locally. This command also automatically formats the code according to Spring standards.** Before committing your code, please create a new branch specific to your feature and commit your changes to this branch.
57
+
58
+
### Local CI
59
+
60
+
After completing development in your local BOE environment, it's strongly recommended to run the provided `make` command in the project's `tools/make` directory to perform local Continuous Integration (CI) checks. This ensures your code adheres to the project's standards and guidelines. If you have questions about local CI, you can enter `make help` in the console for more detailed information.
61
+
62
+
### Commit the Latest Code
63
+
64
+
After completing your coding, you need to format and verify your commit messages according to the PR specification in `[lint-pr-title.yml](.github/workflows/lint-pr-title.yml)` to ensure they comply with the guidelines.
65
+
66
+
Commit format example:
67
+
68
+
```bash
69
+
git commit -m "type(module): descriptive message"
70
+
```
71
+
72
+
For instance: `feat(docs): update contribute-zh`
73
+
54
74
### Merge Latest Code Again
55
75
56
76
- Similarly, before submitting a PR, you need to rebase the code from the main branch (if your target branch is not the main branch, you need to rebase from the corresponding target branch). Please refer to the previous section for specific operation steps.
您可以在[本地部署 Playground 示例](https://github.com/springaialibaba/spring-ai-alibaba-examples/tree/main/spring-ai-alibaba-playground)并通过浏览器访问体验，或者拷贝源码并按照自己的业务需求调整，以便能够快速基于 Spring AI Alibaba 搭建一套自己的 AI 应用。
70
68
71
-
72
69
学习更多 Spring AI Alibaba 框架用法，请参考 Spring AI Alibaba 社区的官方示例源码仓库：
Spring AI Alibaba DeepResearch 是一款基于 Spring AI Alibaba Graph 开发的 Deep Research 智能体, 包括完整的前端 Web UI（开发中） 和后端实现，DeepResearch 支持一系列精心设计的工具，如 Web Search（网络查询）、Crawling（爬虫）、Python 脚本引擎等。借助大模型与工具能力，帮助用户完成各类深度调研报告。
0 commit comments