Update CONTRIBUTING.md

This commit is contained in:
刘旭 2023-03-23 12:06:06 +08:00 committed by GitHub
commit 9f8e1d817a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -35,15 +35,13 @@ Magpie 没有广泛的测试过,因此错误不可避免。希望你能向开
贡献代码是帮助 Magpie 项目最直接的方式,你可以修复 bug增加新功能或修正格式错误。不要因为修改太小就羞于贡献你的每一行修改都很重要。
和所有开源项目一样,你需要提交 pull request 来向 Magpie 贡献代码。开发者可能会要求你做一些更改,如果你无法及时响应,你的 pull request 可能会被关闭。
如果是对已发布功能的 bug 修复,请合并到 main 分支,否则选择 dev 分支。如果你拿不准,合并到 dev 分支就好。
和所有开源项目一样,你需要提交 pull request 来向 Magpie 贡献代码。开发者可能会要求你做一些更改,如果你无法及时响应,你的 pull request 可能会被关闭。你应将提交合并到 dev 分支。
**注意:一旦你向 Magpie 贡献代码,便表示你同意将该代码的版权转让给 Magpie 当前的版权所有者。** 这是为了使开发者做出重大决定(如更换许可证)时无需征得每一个贡献者的同意。开发者承诺 Magpie 项目更换许可证的唯一情形是迁移到更新版本的 GPL 协议。如果你想保留版权,只能放弃贡献,将更改保留在自己的 Fork 中。
贡献代码时你需要遵守一些准则:
1. 和现有的代码风格保持一致包括花括号不换行tab 缩进,变量、类、源文件等的命名方式,所有源码文件格式均为 UTF-8 without BOM大部分情况下采用行注释git 消息风格等等。下面是一个代码风格的示例C++
1. 和现有的代码风格保持一致包括花括号不换行tab 缩进,变量、类、源文件等的命名方式,所有源码文件格式均为 UTF-8 without BOM倾向于使用行注释git 消息风格等等。下面是一个代码风格的示例:
``` c++
// ClassName.h
@ -80,13 +78,10 @@ Magpie 没有广泛的测试过,因此错误不可避免。希望你能向开
```
2. 如果你要进行比较大的更改请先查看 [Projects](https://github.com/Blinue/Magpie/projects) 或提交 pull request 和开发者交流,确保和项目当前的方向一致。
3. 你的分支必须可以通过编译检查。
4. 请尽量应用 VS 检查代码时提出的建议。
### 我想贡献翻译 🌍
贡献新的翻译和修正现有翻译都是非常欢迎的。向 Magpie 贡献翻译非常简单,所有用户界面文本均存储在 resx 中创建新的Resources.xx-xx.resx 文件并翻译所有字符串即可。和[贡献代码](#我想贡献代码-)一样,你需要提交 pull request。强烈推荐你定期维护自己的翻译因为 Magpie 的用户界面经常会进行较大的更改。
**推荐使用 [ResXManager](https://marketplace.visualstudio.com/items?itemName=TomEnglert.ResXManager) 插件。它提供了友好的用户界面,使你无需编写代码。**
贡献新的翻译和修正现有翻译都是非常欢迎的。向 Magpie 贡献翻译非常简单,所有用户界面文本均存储在 src/Magpie.App/Resources.xx-xx.resw 中,创建新的 resw 文件并翻译所有字符串即可。和[贡献代码](#我想贡献代码-)一样,你需要提交 pull request。强烈推荐你定期维护自己的翻译因为 Magpie 的用户界面经常会进行较大的更改。
### 我想贡献文档 📖
@ -96,4 +91,4 @@ Magpie 没有广泛的测试过,因此错误不可避免。希望你能向开
### 我想资助 Magpie 💰
开发者每周都会花费大量的时间开发新功能,这些工作都是无偿的。目前 Magpie 没有资助的渠道,对它进行 Star、Fork 或者宣传就是最好的资助!
请点击页面上方的 "Sponsor" 按钮,非常感谢你的支持。如果能从中获益,我便会将更多精力投入开源项目的开发和维护。