Godot x openKylin大赛正在火热进行中,不少参赛队伍已经开始提交自己的作品和源码,在提交过程中,FAQ SIG集中收集了参赛选手关于源码提交的问题,并编写以下指南。
仓库名称
首先请在提交作品表单填写正确的仓库名称,并确保报名表和作品提交提交表单中填写的Gitee ID一致且签署了openKylin CLA,该Gitee ID对应的参赛选手将成为作品仓库的单包维护者(package maintainer)。
仓库名称必须是以小写字母、数字、短横线或点组成的字符串,并且,第一个字符必须是小写字母(a 到 z 之一)或者数字(0 到 9 之一)。
例如项目名称叫:
MyGodotGame
仓库名可以为:
ghf-mygodotgame
或者ghf-my-godot-game
赛务组会在仓库新建完毕后第一时间通知并告知仓库链接,请保留好仓库链接。
安装和配置Git
提交作品源码需要使用Git,在openKylin系统可以通过apt安装。
sudo apt update
sudo apt install git -y
Windows版本Git下载:Git - Downloading Package
接下来配置Gitee
git config --global user.name "你的Gitee用户名"
git config --global user.email "你的邮箱"
添加许可证和README
为了开源合规,请为项目选择并添加一个许可证,比如常见的MIT、GPL、BSD许可证等。如果想了解各许可证内容,可以通过 https://opensource.org/licenses 这个网站上查看,选择好对应的许可证后请在项目目录下(和project.godot同目录下)新建一个LICENSE文件并以纯文本格式将许可证内容粘贴到LICENSE文件。
如果你并不想阅读许可证原文内容后做决定,这里也提供一个快速选择合适的开源许可证的在线工具 https://choosealicense.com/
README作为源码仓库的规范说明文件,建议使用Markdown格式,标题为项目名称,内容可以包括项目介绍,安装和使用说明,项目结构等。
以下提供一个简单的示例,可以根据自己需求修改。
# MyGodotGame
## 项目介绍
MyGodotGane是一款使用Godot引擎开发的3D肉鸽游戏。
## 安装说明
1. 安装xxx依赖…
## 使用说明
1. 使用Godot 4.x打开
2. 导出Linux x64
## 项目结构
- scripts/:脚本目录
- doc/:文档目录
- assets/:资源目录
添加Git Ignore
项目中的gitignore文件用来告诉Git哪些文件或目录是不需要添加到版本控制中的。比如,编译生成的文件、缓存文件、IDE配置文件等,让仓库就会更加整洁,在Github有一个Gitignore项目,可以参考其中针对Godot项目的gitingore文件,复制模板内容,在项目目录新建一个.gitignore
文件并粘贴。
# Godot 4+ specific ignores
.godot/
# Godot-specific ignores
.import/
export.cfg
export_presets.cfg
# Imported translations (automatically generated from CSV files)
*.translation
# Mono-specific ignores
.mono/
data_*/
mono_crash.*.json
提交作品
在项目目录下打开终端,初始化Git
git init
如果你已经使用Git作为项目版本管理工具,并且已经有提交记录,则跳过上面的步骤。
添加所有修改到暂存区。
git add .
将暂存区的修改提交到本地仓库。
git commit -m "提交信息"
添加远程仓库。
git remote add origin 仓库链接
将本地修改推送到远程仓库的master分支。
git push -u origin "master"
在Gitee上查看提交,提交完成。
关于提交时间
参赛选手需要同时提交作品可执行文件和开源代码,二进制可执行文件(作品本体)提交截止时间为2024年9月17日,由于新建仓库需要时间,开源代码截止时间为2024年10月1日,请在规定时间内完成提交。
如果有疑问,欢迎留言。