# 贡献指南 CONTRIBUTING [欢迎提交代码，任何贡献者都会被铭记。](#jumpGX) ## 如何贡献？ 去 GitHub 提出 拉取申请(pull request) **代码应符合以下要求：** - 已经在项目中使用过。 - 为保证质量，不要提交未使用的代码。 - 不使用 #Include ，只使用 BeanLib 中的已有函数。 - 为保证其他人可以正常使用，应在独立环境中测试。 - 不污染公共空间。 - 不使用全局变量(类对象/函数除外)，不干扰自动执行。 - 之所以类对象和函数可以除外，是因为占用这些是安全的。函数被重复定义，会发出警告；类复写在 `#Warn` 中有单独警告。 - 有简单的介绍。 - 至少有功能/输入/返回值介绍，最好有示例，请使用MD语法，可参考[文档模板](https://www.kancloud.cn/xrvu_zen/ahk_lib/902299)。 - 支持 AHK_L - 请不要使用其他分支的特有语法或函数。 - 禁止触发除 `LocalSameAsGlobal` 外的任何 `#Warn` 警告 - 之所以 `LocalSameAsGlobal` 可以，是因为这个实在是太操蛋了。谁用这玩意?简直反人类，我一般都关掉。 - 禁止使用一切 `魔法数值` 。 - 魔法数值，指的是没有实现定义的任何数值。 - 使用魔法数值会损害可读性。 ### 一些建议和提醒 - 维护者和贡献者，应在关键决策上，尽可能征询公共意见。 - 如有借鉴他人代码，提供出处。 - 尽可能使用函数语法。 - 代码将在 LGPLv3 协议的保护下被发布。 - LGPLv3是使用最广泛的开源协议。 ## <span id="jumpGX">贡献者信息在哪？</span> - [GitHub页面的 Insights/contributors](https://github.com/Oilj/BeanLib/graphs/contributors) 。 - [码云 的"贡献者"页面](https://gitee.com/xrvu_zen/BeanLib/repository/stats/master)。