贡献指南

约 2110 字大约 7 分钟

感谢您对 Cyreneの随机点名器项目的关注和支持！我们欢迎并感谢各种形式的贡献，包括代码提交、文档改进、bug 报告和功能建议等。

行为准则

参与本项目的所有贡献者都应遵守以下行为准则：

尊重他人: 尊重所有贡献者，无论其经验水平、性别、性别认同和表达、性取向、残疾、外貌、种族、年龄、宗教或国籍如何
包容友好: 创造一个友好、包容的环境，欢迎各种背景的贡献者
专业态度: 以专业的态度对待他人，接受建设性的批评
专注于项目: 专注于对项目最有利的事情，而不是个人分歧

如何贡献

报告 Bug

如果您发现了 bug，可以通过以下步骤报告：

搜索现有 Issues: 首先检查是否已经有人报告了相同的问题
创建新 Issue: 如果没有找到相关 Issue，创建一个新的 Issue
详细描述问题: 提供以下信息：
- 软件版本
- 操作系统版本
- 详细的问题描述
- 重现步骤
- 预期行为
- 实际行为
- 相关截图或错误信息
- 可能的解决方案（如果有）

提出功能建议

如果您有功能建议，可以通过以下步骤提出：

搜索现有 Issues: 首先检查是否已经有人提出了相同的建议
创建新 Issue: 如果没有找到相关 Issue，创建一个新的 Issue
详细描述建议: 提供以下信息：
- 建议的功能描述
- 为什么需要这个功能
- 功能的预期行为
- 可能的实现方案（如果有）

提交代码

如果您想提交代码贡献，请按照以下步骤操作：

Fork 仓库: 在 GitHub 上 Fork 项目仓库到您自己的账户

克隆仓库: 将 Fork 后的仓库克隆到本地

git clone https://github.com/您的用户名/CyreneNameRoller.git
cd CyreneNameRoller

创建分支: 创建一个新的分支来开发您的功能或修复

git checkout -b feature/您的功能名称
# 或
git checkout -b fix/您的修复名称

安装依赖: 安装项目依赖
```
npm install
```
开发代码: 实现您的功能或修复
测试代码: 确保您的代码能够正常工作
```
npm run dev
```

提交更改: 提交您的更改

git add .
git commit -m "描述您的更改"

推送到 GitHub: 将您的分支推送到 GitHub
```
git push origin feature/您的功能名称
```
创建 Pull Request: 在 GitHub 上创建一个 Pull Request，描述您的更改

改进文档

如果您想改进文档，可以按照以下步骤操作：

Fork 仓库: 在 GitHub 上 Fork 项目仓库到您自己的账户
克隆仓库: 将 Fork 后的仓库克隆到本地
创建分支: 创建一个新的分支来修改文档
修改文档: 改进或添加文档内容
提交更改: 提交您的更改
推送到 GitHub: 将您的分支推送到 GitHub
创建 Pull Request: 在 GitHub 上创建一个 Pull Request，描述您的更改

开发环境设置

系统要求

操作系统: Windows 10/11 (64位)
Node.js: 18 或更高版本
npm: 9 或更高版本
Git: 用于版本控制

安装依赖

克隆仓库

git clone https://github.com/Cyrene2008/CyreneNameRoller.git
cd CyreneNameRoller

安装依赖
```
npm install
```
运行开发服务器
```
npm run dev
```
构建 Electron 客户端
```
npm run electron:build
```

开发工具

推荐使用以下开发工具：

IDE: Visual Studio Code
浏览器: Chrome (用于调试 Electron 应用)
版本控制: Git

测试

在提交代码之前，请运行测试确保您的更改不会破坏现有功能：

npm run dev

代码规范

命名规范

文件和目录: 使用小写字母，单词之间用连字符分隔
组件名: 使用驼峰命名法（PascalCase）
函数和变量: 使用驼峰命名法（camelCase）
常量: 使用全大写字母，单词之间用下划线分隔
CSS 类名: 使用连字符分隔

代码风格

缩进: 使用 2 个空格进行缩进
空行: 适当使用空行分隔不同的代码块
注释: 为复杂的代码添加注释，解释代码的功能和逻辑
文档字符串: 为函数、类和模块添加文档字符串

提交消息规范

提交消息应遵循以下格式：

类型(范围): 描述

详细描述（可选）

引用相关 Issue（如果有）

类型包括：

feat: 新功能
fix: bug 修复
docs: 文档更改
style: 代码风格更改（不影响功能）
refactor: 代码重构（不添加新功能或修复 bug）
perf: 性能优化
test: 添加或修改测试
chore: 构建或依赖项更改

范围是可选的，指定更改的范围，例如：

ui: 用户界面
core: 核心功能
random: 随机点名功能
flip: 翻牌点名功能
data: 数据管理功能

描述是对更改的简短描述，不超过 50 个字符。

详细描述是对更改的详细说明，可选。

引用相关 Issue是指引用与更改相关的 GitHub Issue，例如：Closes #123。

发布流程

版本号规范

项目使用语义化版本号（Semantic Versioning）：

主版本号: 当进行不兼容的 API 更改时递增
次版本号: 当添加向后兼容的新功能时递增
补丁版本号: 当进行向后兼容的 bug 修复时递增

发布步骤

更新版本号: 在 package.json 中更新版本号
更新 CHANGELOG: 更新 CHANGELOG.md 文件，记录本次发布的更改
运行测试: 确保所有测试都通过
构建发行版: 构建 Electron 应用
```
npm run electron:build
```
创建 GitHub Release: 在 GitHub 上创建新的 Release，上传构建的安装包

贡献者指南

成为贡献者

任何人都可以成为 Cyreneの随机点名器的贡献者，无论您的经验水平如何。我们欢迎：

代码贡献: 修复 bug、添加新功能
文档贡献: 改进文档、添加示例
测试贡献: 编写测试用例
社区贡献: 回答问题、帮助其他用户

贡献者行为准则

作为贡献者，我们期望您：

尊重他人: 尊重所有贡献者和用户
专业态度: 以专业的态度对待工作
积极沟通: 及时回应相关的 Issue 和 Pull Request
持续学习: 不断学习和提高自己的技能

贡献者认可

我们非常重视所有贡献者的工作，并通过以下方式认可贡献者：

贡献者列表: 在 README.md 中列出所有贡献者
GitHub 贡献图: 通过 GitHub 的贡献图展示贡献
Release 说明: 在 Release 说明中感谢贡献者

常见问题

Q: 我是新手，如何开始贡献？

A: 您可以从以下方面开始：

修复简单的 bug
改进文档
回答其他用户的问题
为项目添加测试

Q: 如何获取项目的最新信息？

A: 您可以通过以下方式获取项目的最新信息：

关注 GitHub 仓库的动态
订阅项目的 Issue 和 Pull Request
加入项目的交流群（如果有）

Q: 贡献代码需要遵循什么流程？

A: 请参考本指南中的「提交代码」部分，按照流程提交您的代码贡献。

Q: 如何与项目维护者沟通？

A: 您可以通过以下方式与项目维护者沟通：

GitHub Issues 和 Pull Requests
项目的交流群（如果有）
邮件（如果提供）

Q: 贡献被拒绝了怎么办？

A: 如果您的贡献被拒绝，不要灰心。维护者会给出具体的原因，您可以根据反馈进行改进，然后再次提交。

联系方式

GitHub 仓库: https://github.com/Cyrene2008/CyreneNameRoller
Issue tracker: https://github.com/Cyrene2008/CyreneNameRoller/issues
Pull Requests: https://github.com/Cyrene2008/CyreneNameRoller/pulls

许可证

Cyreneの随机点名器使用 CC BY-NC-SA 4.0 许可证。详情请查看 LICENSE 文件。

核心贡献者

Cyrene2008（星海昔涟） - 项目作者 & 主要维护者
- GitHub: @Cyrene2008
LeafS825（叶背影） - 贡献者
- GitHub: @LeafS825

感谢您对 Cyreneの随机点名器项目的关注和支持！我们期待您的贡献，让这个项目变得更好。

贡献者

Cyrene2008

更新日志

2026/7/9 09:02

查看所有更新日志

c62e2-docs: 根据项目实际代码全面修正文档内容于 2026/7/9