Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.11 KB

CONTRIBUTING.MD

File metadata and controls

43 lines (30 loc) · 1.11 KB

Contributing


Welcome to systemXK

What should I know before i get started?

  • How to use google.
  • we don't specific languages
  • but DON'T use Java

Style guides

Git

Git Commit Messages

  • 第一行不要超过30个字符宽度
  • 需要表达出commit做了什么
  • 可以使用以下表情来做开头
    • 🎨 :art: 表示整理代码、重构
    • 📝 :memo: 表示编写文档
    • 🐛 :bug: 表示修复一个bug
    • 🔥 :fire: 表示移除文件(夹)
    • 🔒 :lock: 表示处理与安全有关的问题
    • ⬆️ :arrow_up: 表示升级依赖
    • ⬇️ :arrow_down: 表示降级依赖
    • :white_check_mark: 表示添加测试
    • :sparkles: 表示添加功能

Git commit 和 push的时机

  • 确保你的代码在你能想到的范围内工作
  • 确保Commit Message有意义

请删除非测试文件中注释掉的代码

命名

  • 绝对禁止混用英语和拼音
  • 绝对禁止使用单个字母的变量名
  • 在使用任何非框架例程简写前请添加在abbreviation.MD