mirrors/Magpie
2
0
Fork 0
mirror of https://github.com/Blinue/Magpie.git synced 2026-06-24 02:04:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
刘旭 2021-12-22 10:21:56 +08:00 • committed by GitHub
commit 8160f15b5a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -19,7 +19,7 @@ Magpie 没有广泛的测试过，因此错误不可避免。希望你能向开
首先请在 Issue 和 Discussion 中搜索你遇到的错误，避免和现有 Issue 重复。汇报错误时请发布一个 [Issue（bug report）](https://github.com/Blinue/Magpie/issues/new?assignees=&labels=bug&template=01_bug.yaml)，下面是一些有利于开发者快速定位问题的最佳实践：
1. 选择一个清晰简洁的标题，可以在标题前加上[bug]标签。如 “[bug] Windows 11窗口圆角导致游戏窗口超分后左下/右下角模糊” 是一个好标题，而 “应用程序错误” 则意义不明。
2. 上传日志文件对定位问题特别有帮助，它们位于 logs 文件夹下。**请以文件的形式上传日志，而不是将其中的内容复制到文本框中。**
2. 上传日志文件对定位问题特别有帮助，它们位于 logs 文件夹下。**请以附件的形式上传日志，而不是将其中的内容复制到正文中。**
3. 请详细的描述复现步骤，最好提供一些截图。
4. 还有一些信息可能对开发者有帮助，比如特殊的显示器配置，显卡型号等。
@ -29,7 +29,7 @@ Magpie 没有广泛的测试过，因此错误不可避免。希望你能向开
首先请在 Issue 中搜索你的功能建议，确保不和已有的重复，尤其要查看 [Projects](https://github.com/Blinue/Magpie/projects) 里是否有这个功能。然后提交一个 [Issue (feature request)](https://github.com/Blinue/Magpie/issues/new?assignees=&labels=enhancement&template=03_request.yaml) 详细地描述你的建议，比如是否有其他软件实现了类似的功能。
**如果你想请求一个新的效果，请明确说明它的名称，适用场景以及已有的着色器实现（如果有的话），强烈建议展示和现有效果的对比。**
**如果你想请求一个新的效果，请明确说明它的名称，适用场景以及已有的着色器实现（如果有的话），另外强烈建议你附上和现有效果的对比图。**
### 我想贡献代码 💻
@ -39,7 +39,7 @@ Magpie 没有广泛的测试过，因此错误不可避免。希望你能向开
如果是对已发布功能的 bug 修复，请合并到 main 分支，否则选择 dev 分支。如果你拿不准，合并到 dev 分支就好。
**注意：一旦你向 Magpie 贡献代码，便表示你同意将该代码的版权转让给 Magpie 当前的版权所有者。Magpie 可能在没有征得你的同意的情况下更换许可证。** 这是为了使开发者做出重大决定时无需征得每一个贡献者的同意，开发者承诺 Magpie 项目更换许可证的唯一情形是迁移到更新版本的 GPL 协议。如果你想保留版权，只能放弃贡献，将更改保留在自己的 Fork 中。
**注意：一旦你向 Magpie 贡献代码，便表示你同意将该代码的版权转让给 Magpie 当前的版权所有者。** 这是为了使开发者做出重大决定（如更换许可证）时无需征得每一个贡献者的同意。开发者承诺 Magpie 项目更换许可证的唯一情形是迁移到更新版本的 GPL 协议。如果你想保留版权，只能放弃贡献，将更改保留在自己的 Fork 中。
贡献代码时你需要遵守一些准则：