Skip to content

Albertsun6/cursor-learning

Repository files navigation

Cursor IDE 学习与整理项目

这个项目用于学习和整理 Cursor IDE 的各种功能和使用技巧。

📋 项目概述

  • 版本: 1.0.0
  • 状态: 活跃开发中
  • 许可证: MIT
  • 创建时间: 2024年1月

🎯 项目目标

  • 📚 提供完整的 Cursor IDE 学习资源
  • 🚀 整理最佳实践和使用技巧
  • 🤝 建立活跃的社区和贡献机制
  • 📈 持续更新和完善文档内容

📁 项目结构

Cursor/
├── README.md                 # 项目主文档
├── CHANGELOG.md             # 版本更新日志
├── CONTRIBUTING.md          # 贡献指南
├── package.json             # 项目配置
├── .gitignore               # Git 忽略文件
├── .markdownlint.json       # Markdown 规范配置
├── .github/                 # GitHub 配置
│   ├── ISSUE_TEMPLATE/      # Issue 模板
│   ├── workflows/           # GitHub Actions
│   └── PULL_REQUEST_TEMPLATE.md
├── features/                # 功能文档目录
│   ├── tab-snooze.md       # 标签页打盹功能
│   ├── ai-assistant.md     # AI 助手功能
│   └── keyboard-shortcuts.md # 快捷键
├── guides/                  # 使用指南
│   ├── getting-started.md  # 入门指南
│   └── best-practices.md   # 最佳实践
├── tips/                    # 使用技巧
│   └── productivity-tips.md # 生产力技巧
└── examples/                # 示例代码
    └── README.md           # 示例说明

🚀 快速开始

1. 克隆项目

git clone https://github.com/your-username/cursor-learning.git
cd cursor-learning

2. 本地开发

# 安装依赖
npm install

# 验证文档
npm run validate

# 格式化文档
npm run format

# 检查链接
npm run check-links

3. 贡献代码

请查看 贡献指南 了解如何参与项目开发。

📚 快速导航

功能文档

使用指南

使用技巧

🔄 版本管理

当前版本

  • 版本号: 1.0.0
  • 发布日期: 2024年1月
  • 状态: 稳定版本

版本历史

详细版本信息请查看 CHANGELOG.md

版本规范

本项目遵循 语义化版本 规范:

  • 主版本号: 不兼容的 API 修改
  • 次版本号: 向下兼容的功能性新增
  • 修订号: 向下兼容的问题修正

🤝 参与贡献

贡献方式

  1. 报告问题 - 使用 Issue 模板
  2. 提交功能请求 - 描述新功能想法
  3. 改进文档 - 修正错误或添加内容
  4. 提交代码 - 通过 Pull Request 贡献代码

开发流程

  1. Fork 项目
  2. 创建功能分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 创建 Pull Request

提交规范

我们使用 Conventional Commits 规范:

  • feat: 新功能
  • fix: 错误修复
  • docs: 文档更改
  • style: 格式调整
  • refactor: 代码重构
  • perf: 性能优化
  • test: 测试相关
  • chore: 构建过程或辅助工具的变动

🛠️ 技术栈

  • 文档格式: Markdown
  • 版本控制: Git
  • CI/CD: GitHub Actions
  • 代码规范: Markdownlint + Prettier
  • 项目管理: npm

📈 项目统计

  • 📄 文档数量: 8 个主要文档
  • 🔗 内部链接: 完整的文档导航
  • 🌍 平台支持: macOS、Windows、Linux
  • 📝 内容类型: 功能文档、使用指南、技巧分享、示例代码

🎉 项目创建过程

创建背景

这个项目起源于用户提供的 Cursor Tab Snooze 功能帮助信息,经过系统化整理和扩展,形成了完整的 Cursor IDE 学习资源库。

创建步骤

  1. 需求分析 - 整理用户提供的 Tab Snooze 功能信息
  2. 结构设计 - 建立完整的文档体系结构
  3. 内容创建 - 编写各个功能模块的详细文档
  4. 版本管理 - 添加 Git 和 GitHub 相关配置
  5. 质量保证 - 设置代码规范和 CI/CD 流程

技术实现

  • 使用 Markdown 格式编写文档
  • 建立清晰的目录结构
  • 添加完整的内部链接导航
  • 配置 GitHub Actions 自动化流程
  • 设置代码规范和提交规范

📞 联系我们

📄 许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。

🙏 致谢

感谢所有为这个项目做出贡献的人!特别感谢:

  • Cursor IDE 开发团队
  • 提供初始 Tab Snooze 功能信息的用户
  • 所有参与贡献的社区成员

⭐ 如果这个项目对你有帮助,请给我们一个星标!

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published