Branch Management Scheme 分支管理方案

[lace-wing]

Catalogue

• English
  • Structure
  • Naming rules
  • Content management
  • Branch creation and merging
  • Notice
• 中文
  • 分支构成
  • 命名规则
  • 内容管理
  • 分支开设与合并
  • 注意事项

Everglow's Branch Management Scheme

Structure

• master, the main branch
• common, under master
• hotfix, under master
• localization, under master
• module, under master
• submodule, under module

Naming rules

• master: master
• common: common/\<feature>
• hotfix: hotfix
• localization: localization
• module: \<module name>
• submodule: \<module name>/\<feature>

Content management

• master: completely playable product
• common: public resources, includes core(functions independent to the game), function(widely used game-related systems) and resource
• hotfix: hotfixes for the master branch
• localization: localization for the master branch
• module: relatively independent contents, have to be debuggable and testable
• submodule: features of the respective modules

Branch creation and merging

• common：created when adding new common features, one branch per feature, merged into master after debugging, sync with master
• hotfix：permanent branch, merged into master after debugging, sync with master
• localization：permanent branch, updated when a module is merged into master, merged into master after update
• module：created when adding main features, merged into master after implementation, sync with master
• submodule：created when adding modular features, merged into respective modules after implementation, sync with respective modules

Notice

• Please mark wherever needs localization using //TODO Localization needed

流光无际分支管理方案

分支构成

• master，主分支
• common，master下
• hotfix，master下
• localization，master下
• module，master下
• submodule，module下

命名规则

• master：master
• common：common/\<feature>
• hotfix：hotfix
• localization：localization
• module：\<module name>
• submodule：\<module name>/\<feature>

内容管理

• master：完全可玩的成品
• common：公共资源，下有core，function和resource
• hotfix：针对master的紧急修复
• localization：对master的本地化
• module：相对独立的内容，要求可debug和测试
• submodule：对应module下的小功能

分支开设与合并

• common：新增common功能时开设，每种功能单独开一个分支，调试完成后立即合并进master，与master同步
• hotfix：常驻，修复完后立即合并进master，与master同步
• localization：常驻，有module合并进master时更新，完成后立即合并进master
• module：新增主要内容时开设，完善后合并进master，与master同步
• submodule：新增小功能时开设，完善后立即合并进对应module，与对应module同步

注意事项

• 需要进行本地化的地方请用//TODO Localization needed标记，不然很难找的

[Setnour6]

Can we still use our names for the new branches, such as "setnour6/Yggdrasil/MothEye-FBB-Rework", or does it strictly have to be module names, such as "Yggdrasil/MothEye-FBB-Rework"?

[Solaestas]

i think it's better to use Yggdrasil/setnour6, as we sometimes don't want to mix up modules

(real name is hidden) @.***

 

------------------ 原始邮件 ------------------ 发件人: "dfgasdfg/Everglow" @.>; 发送时间: 2022年10月21日(星期五) 晚上10:22 @.>; @.***>; 主题: Re: [dfgasdfg/Everglow] Branch Management Scheme 分支管理方案 (Issue #20)

Can we still use our names for the new branches, such as "setnour6/Yggdrasil/MothEye-FBB-Rework", or does it strictly have to be module names, such as "Yggdrasil/MothEye-FBB-Rework"?

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you are subscribed to this thread.Message ID: @.***>

[Setnour6]

i think it's better to use Yggdrasil/setnour6, as we sometimes don't want to mix up modules

Sure, though I am used to seeing names, and then modules, and then features, such as "omnielement/firefly/fireworm" for example, to see who is assigned to or mainly working on the branch.