Cursor rule

.cursor/rules/document.mdc

[object Object]

Cursor rules

Quality

30/100

Scores the file, not the repository.

Length

74 words

7 headings · 0 code blocks

Repository

251

— · pushed 4 days ago

Last changed

3 days ago

First indexed 3 days ago.

flyeric0212/cursor-history-links/.cursor/rules/document.mdcRaw GitHub

1---
2description: 
3globs: *.md
4alwaysApply: false
5---
6# 文档规范
7 
8## 通用要求
9- 所有文档使用Markdown格式
10- 使用简洁、清晰的语言
11- 文档内容应保持最新
12- 避免拼写和语法错误
13- 使用中文作为主要语言
14 
15## 目录结构
16- `README.md`：项目根目录，提供项目概述
17- `docs/`：存放详细文档
18  - `guide/`：使用指南
19  - `api/`：API文档
20  - `examples/`：示例代码文档
21 
22## README.md 内容规范
23- 项目名称和简短描述
24- 技术栈说明
25- 项目结构说明
26- 使用说明
27- 许可证信息
28 
29## 版本记录规范
30- 使用 `CHANGELOG.md` 记录版本变更
31- 遵循语义化版本（Semantic Versioning）规范
32- 每个版本应包含：新增功能、修复问题、破坏性变更
33 
34## 文档内容组织
35- 从整体到局部，从简单到复杂
36- 重要信息放在前面
37- 相关内容应当放在一起
38- 使用小标题和列表增强可读性
39- 避免过长段落，保持内容简洁
40 
41## 代码示例规范
42- 提供完整可运行的示例
43- 代码应当简洁且易于理解
44- 添加适当的注释解释关键部分
45- 说明代码的预期输出或行为
46- 更新示例以匹配最新API

Also in flyeric0212/cursor-history-links

Diff this repo’s formats

One repository carrying more than one format is the comparison this product exists for: does anyone actually write different content in each file, or is one a copy of the other?

The other instruction files in this repository
Repository	Format	Stack	Covers	Score	Changed
flyeric0212/cursor-history-links.cursor/rules/general.mdc · 251	Cursor rules	pythongithub-actions	no sections	30/100	3 days ago
flyeric0212/cursor-history-links.cursor/rules/git.mdc · 251	Cursor rules	pythongithub-actions	git	25/100	3 days ago
flyeric0212/cursor-history-links.cursor/rules/python.mdc · 251	Cursor rules	pythongithub-actions	docs	13/100	3 days ago

Diff against .cursor/rules/general.mdc Diff against .cursor/rules/git.mdc Diff against .cursor/rules/python.mdc

Similar configs

Same format, overlapping stack, ranked by quality.

Same format, overlapping stack, ranked by quality
Repository	Format	Stack	Covers	Score	Changed
TechSquidTV/Hermes.cursor/rules/10-hermes-api.mdc · 45	Cursor rules	typescriptpytest+15	testlint-formatstylearch+5	100/100	3 days ago
hiromaily/go-crypto-wallet.cursor/rules/typescript.mdc · 126	Cursor rules	gobun+5	setupbuildtestlint-format+6	100/100	3 days ago
langflow-ai/langflow.cursor/rules/docs_development.mdc · 153k	Cursor rules	pythonnode+16	setupbuildtestlint-format+7	97/100	3 days ago
TechSquidTV/Hermes.cursor/rules/20-hermes-api-tests.mdc · 45	Cursor rules	typescriptpytest+15	teststyletesting-strategysecurity+3	97/100	3 days ago
skillrecordings/egghead-next.cursor/rules/project-update-user-rules.mdc · 1.4k	Cursor rules	typescriptnode+14	buildtestlint-formatstyle+7	96/100	3 days ago
skillrecordings/egghead-next.cursor/rules/project-update-rules.mdc · 1.4k	Cursor rules	typescriptnode+14	buildtestlint-formatstyle+7	96/100	3 days ago
nerds-odd-e/doughnut.cursor/rules/cli.mdc · 49	Cursor rules	typescriptcypress+14	setupbuildteststyle+4	96/100	3 days ago
hiromaily/go-crypto-wallet.cursor/rules/proto.mdc · 126	Cursor rules	gobiome+4	buildlint-formatstylearch+3	96/100	3 days ago