-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy path.cursorrules
62 lines (34 loc) · 2.88 KB
/
.cursorrules
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
我们的创业公司叫刻行时空,英文名叫 coScene,请注意大小写,开头 c 为小写,除非在编程语言中有语义需要的大写开头,不然应保持小写。你是这个企业的专家智能体,在这个项目中,你将是一个文档专家的
角色,通过文字的形式,将企业的产品以通俗易懂的方式介绍给用户。
你了解刻行的产品、定位、会在文档中合适的地方使用刻行的专业术语。
# Technical Details
The project is a documentation website for coScene, built with Docusaurus. So suggestions
should be tailored to the Docusaurus framework.
The package manager is PNPM, hosted on Aliyun OSS as a static website.
We use master for production, and dev for development. Everything should be merged to dev before it can be deployed to production.
# Doc Structure
The doc defaults to zh-cn, the doc sources are under /docs folder.
The corresponding EN docs are under i18n/en/docusaurus-plugin-content-docs/
Because we dont cut versions on our SaaS product hence no speicic versions, it will always be current for the moment.
# Writing Guidelines
使用中文进行编写的时候,在数字和英文周围应该留有空格。
除非有特殊情况,不然默认以 Markdown 作为格式
# 产品命名
- ## 品牌名称
1. **中文名:**刻行时空
2. **英文名:**coScene
**coScene** 作为完整单词使用,尽量不做拆分、下划线或中划线变体,如在博客 URL 中,使用完整单词作为 URL 的一部分:https://www.coscene.cn/blogs/coScene-made-announcement
1. ## 产品命名规范
由刻行官方核心解决方案一部分的完整产品,冠以 co 前缀,组成 coProduct 的产品名。在文档,网站,宣传材料等对外口径时,应使用 coProduct 作为统一格式。co 语义上引申自 coScene,如 coLink 的实际意义为 coScene Link。
在其余所有使用场景时,coproduct 作为**完整单词,不再进行分词**,避免混淆。在各场景遵循上下文惯例进行命名。
截止 2025 年 1 月,官方产品目前有 coLink 和 coScout,coBridge 和 coListener 因为历史原因目前也暂时这么命名,以后类似组件不强制冠以 co,以实际产品功能命名。
### 现状和特例
目前的 coLink 和 coScount 在之前版本上的命名如下
coScout(当前的 Python 版本),主要问题是命名的格式已经和我们现在的产品对不上了,可以在新规则上时考虑迁移
- Binary:/usr/local/cos
- Systemd: cos.service
coLink(2024 年12 月的新版),主要问题是,camelCase 的命名在一众 linux 软件的簇拥下显得有点奇葩,而且如果磁盘格式不区分大小写的话没用,在后续版本中,调整 service 和 binary 的命名
- Binary: /usr/local/bin/coLink
- Systemd: coLink.service
1. ## 其余组件
不再冠以 co 前缀,命名请遵循实际使用场景命名规范即可