教你如何一起开发《无名杀》，代码提交规范

大家好，我是桌游小扩

随着Pull Request无名杀仓库的开发者越来越多

开发组整理了一下Github上的wiki

主要说明如何使用Git将代码提交到无名杀

以及开发规范，便于维护无名杀

保障了代码质量，才能更好的前进发展

感谢众多开发者的无私奉献

无名杀才能走到现在

Git下载安装指南

以下是针对Windows平台下Git的下载及安装步骤的简化指南，适用于大多数情况下用户安装Git：

步骤1：下载Git 访问官方Git下载站点获取最新版本的Git：

地址：https://git-scm.com/downloads

根据操作系统选择适合的版本下载，对于Windows用户通常选择“Git for Windows Setup”。

步骤2：运行安装程序

找到下载好的安装文件（通常是Git-x.x.x.exe这样的格式），双击运行。

点击“Next”继续安装过程。

步骤3：选择安装选项

在安装界面，可以选择“Typical”或“Custom”安装方式。如果是新手，建议采用典型安装。

若选择自定义安装，则可以：

选择安装路径（例如，为了减少系统分区压力，可以选择非C盘的位置安装）。

选择是否将Git Bash Here和Git GUI Here添加到上下文菜单（方便右键菜单直接调用Git命令行或图形界面）。

选择默认的文本编辑器（如默认的Vim，也可以选择Notepad++或其他你喜欢的编辑器）。

选择是否启用Unix工具（如bash、sed、awk等）。

设置初始分支名称（根据项目需要，可能是main或master）。

步骤4：配置PATH环境变量

在安装过程中，确保勾选“Use Git from the Windows Command Prompt”或类似选项，这会自动配置系统环境变量，使得可以在任意命令行窗口直接使用Git命令。

步骤5：安装完成

按照安装向导的指示，持续点击“Next”直至“Install”，然后等待安装完成。

安装结束后，取消勾选创建桌面快捷方式（如果不需要的话），并点击“Finish”完成安装。

验证安装

打开命令提示符（CMD）或 PowerShell，输入git --version，如果显示出Git的版本信息，说明Git已经正确安装并且能够在命令行中使用了。

注意：实际安装过程中可能会有一些细节差异，因为Git的安装程序可能会随着版本更新而有所改变，但上述步骤提供了通用的安装流程。在安装时，请留意界面上的提示信息，根据自己的需求做出相应的选择。

《无名杀》项目 Pull Request 提交规范

编程风格与格式约定

1. 缩进规范

为了保证代码一致性及可读性，所有参与者在编写JavaScript代码时必须统一使用Tab字符进行缩进，禁止使用空格键代替。请预先配置好你的编辑器，确保其默认设置为每级缩进使用一个制表符。

2. 代码风格

请遵循ESLint或者项目内已有的代码风格规范，并确保在提交前运行lint工具进行检查并修正错误。

3. 提交信息

每次提交应附带清晰且有意义的提交信息，采用动词短语的形式，例如：“添加新功能 X” 或 “修复 issue #123: Bug description"。

分支管理与Pull Request流程

4. PR提交分支规定

所有的新功能、Bug修复以及其他代码变动都必须首先提交到名为PR-Branch的开发分支，不得直接提交到master主分支。

5. 文档与注释

新增方法需要JS Doc形式注释，标注每个参数以及返回值的作用。

若涉及到复杂的逻辑修改或新增功能，请尽可能提供设计思路、实现原理以及可能的影响分析。

6. 代码审查与讨论

耐心等待项目维护者或其他成员对您的PR进行审查，并积极回应审查中的提问和建议。

修改后的代码应当再次经过测试，并确保所有先前通过的测试依然能通过。

7. 合并

只有当PR得到至少一位项目维护者的批准，并通过检查后，该PR才会被合并到PR-Branch。

遵循以上规范，我们能够更高效地协作，共同保障代码质量和项目的健康发展。再次感谢您对《无名杀》项目的贡献和支持！

如何提交代码到《无名杀》Github仓库

以下是一份简化的快速指南，用于指导新人如何在GitHub上的开源项目“无名杀”上提交Pull Request (PR)：

步骤一：Fork项目到个人账户

访问https://github.com/libccy/noname。

在页面右上角找到并点击"Fork"按钮，将该项目复制到您的GitHub个人账户下。

步骤二：Clone到本地并设置上游仓库

在本地终端，使用git clone命令将fork后的项目克隆到本地：

git clone https://github.com/your-username/noname.git

cd noname

添加原项目（upstream）作为远程仓库以便后续同步更新：

git remote add upstream https://github.com/libccy/noname.git

git fetch upstream

步骤三：创建新分支并进行更改

切换到PR指定的目标分支（此处是PR-Branch）并确保它是最新版本：

git checkout -b your-feature-branch upstream/PR-Branch

在此分支上进行代码修改、添加或删除，并确保符合项目编码规范和贡献指南。

当完成修改后，将它们添加到暂存区：

git add .

提交变更：

git commit -m "描述你的改动：新增功能/修复问题/改进文档等"

步骤四：推送分支到个人仓库

将你的改动推送到你在GitHub上的fork：

git push origin your-feature-branch

步骤五：创建Pull Request

回到GitHub网站，进入你的noname仓库页面，你会看到一个提示，告知你有一个新的未推送分支。

点击“Compare & pull request”按钮或者直接导航到“Pull requests”选项卡并点击“New pull request”。

在对比页面，确认源分支是你的your-feature-branch，目标分支是noname:PR-Branch。

填写PR标题和详细描述，包括为何做这些修改、如何测试、以及是否解决了某个Issue（如果有相关联的issue，请提及issue编号如#123）。

如果项目有PR模板，务必按照模板填写所有必要信息。

确认所有信息无误后，点击“Create pull request”。

步骤六：等待审阅与合并

创建完PR后，通知项目维护者或核心成员，并等待他们对你的代码进行审阅。

根据反馈做出相应修改，并及时更新到你的分支上。

维护者接受你的PR并将其合并到PR-Branch后，你可以清理本地环境，比如删除已合并的feature分支。

以上就是向开源项目“无名杀”提交Pull Request的基本步骤。请根据实际情况调整命令和分支名称。同时，每个项目可能有不同的贡献指南，请务必遵守。