代码贡献指南

为我们做出贡献

注意

不要在我们的Gitee镜像上贡献，您在Gitee的贡献无法被同步到GitHub

1. 创建一个NamePicker的复刻（Fork）到您的GitHub账号

提示

第2-7步都可以使用工具实现（例如VS Code，JetBrains IDE）

具体使用方式请自行搜索

2. 将仓库克隆到本地（将<YourGithub>替换成您的GitHub账户名）

git clone

git clone https://github.com/<YourGithub>/NamePicker.git

GitHub cli

gh repo clone <YourGithub>/NamePicker

3. 切换到您的工作目录

cd NamePicker

4. 在Dev分支的基础上创建新分支（将<your-branch-name>替换为您的分支名字（例如feature））

git checkout dev
git checkout -b <your-branch-name>

5. 创建虚拟环境并安装依赖

注

我们假设您已经安装了Python3，如果您没有安装，请自行寻找教程

Windows

python3 -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -r requirements.txt

Linux

您可能需要将第一步的指令替换成在您的发行版上安装python3-venv的指令

sudo apt install python3-venv
python3 -m venv .venv
source ./.venv/bin/activate
pip install -r requirements.txt

6. 在该分支做出您的贡献

7. 将该分支同步到远程仓库（将<your-branch-name>替换为您在第4步设置的分支名字）

git push --set-upstream origin <your-branch-name>

8. 在GitHub上发起Pull Request，随后等待开发者审核