Skip to content

Commit

Permalink
📃 docs(contribute): edit crash-report
Browse files Browse the repository at this point in the history
edit crash-report page
edit GitHub Issue template
edit contributor profile
  • Loading branch information
bingling-sama committed Feb 16, 2024
1 parent d1d4435 commit 375e67a
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/CRASH-UPLOAD.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ body:
id: log-files
attributes:
label: "日志文件"
description: 如果日志太长无法提交,请将日志文件拖放到这里
placeholder: 不要在这里粘贴日志
description: 请优先使用 [MCLogs](https://mclo.gs) 提交日志
placeholder: 粘贴 MCLogs 链接、粘贴日志内容或上传日志文件
validations:
required: true
- type: dropdown
Expand Down
2 changes: 1 addition & 1 deletion docs/.vitepress/data/members.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const members = [
{
avatar: "https://cdn.crashmc.com/https://github.com/bingling-sama.png",
name: "bingling-sama",
title: "开发者",
title: "开发者 | 文档贡献者",
links: [{ icon: "github", link: "https://github.com/bingling-sama" }],
},
{
Expand Down
24 changes: 22 additions & 2 deletions docs/contribute/crash-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,28 @@ contributors: [bingling-sama]

# 崩溃提交

如果您遇到的问题无法在本文档中找到答案,可以点击[这里](https://github.com/GlobeMC/crashmc.com/issues/new/choose)向我们提交您的错误报告,我们将尽快为您解决问题。同时,您所上传的崩溃日志也将作为改进文档的资料使用,感谢您为本文档提供数据。
如果您遇到的问题无法在本文档中找到答案,可以点击 [这里](https://github.com/GlobeMC/crashmc.com/issues/new/choose) 向我们提交您的错误报告,我们将尽快为您解决问题。同时,您所上传的崩溃日志也将作为改进文档的资料使用,感谢您为本文档提供数据。

为了方便我们为您检索问题,在上传 `*.log`/`*.txt` 等文本格式文件时,请优先前往 [MCLogs](https://mclo.gs) 上传文件内容并向我们提供网站生成的链接。

:::info 注意
在提交崩溃报告时,您首先要在 [GitHub](https://github.com) 网站注册一个帐号,以便我们对问题的后续跟踪。
在提交崩溃报告时,您首先要在 [GitHub](https://github.com) 网站注册一个帐号,以便我们对问题进行后续跟踪。

提交崩溃信息时,各工具的优先级如下:

- [MCLogs](https://mclo.gs)
- [GitHub Gist](https://gist.github.com)
- 其他 Pastebin 网站
- GitHub Issues 内 **使用 `Details Block`** 上传日志内容
- GitHub Issues 内直接上传文件
:::

## GitHub Details

在 GitHub Issues 中粘贴游戏崩溃日志时,建议使用 Details Block 来增加 Issue 可读性。

在 GitHub 输入框中键入 `/` 后,就会弹出 Slash Commands 选框:

![details](https://cdn.crashmc.com/https://github.com/GlobeMC/CrashMC_Pics/raw/main/contribute/details-block.jpg)

单击 Details 选项,就可以快捷输入 Details Block,此时便可以编辑 `summary``details` 块。建议在 `summary` 块中输入文件名,在 `details` 块中粘贴日志内容。

0 comments on commit 375e67a

Please sign in to comment.