更快地撰写更好的报告

如果你在寻找如何让你的提交报告看起来漂亮和专业的技巧，你找对文章了！

让我在这里分享一些你可以从今天开始使用的技巧和工具，以提高你报告的可读性和外观。

这不是一篇关于写作好的报告，而是关于写作华丽报告的文章，这就是为什么我只会谈论报告的形式，而不是内容的原因。

使用正确的模板

首先让我们从显而易见的开始。无论你是在参加 Code4rena、Sherlock、CodeHawks、Immunefi， 还是任何其他竞争平台，你都必须遵循模板。 这很重要，因为评委将审核数百份提交，你很容易理解这如何帮助他们更快地进行审核。

#L/M/H-00 - 描述

## 漏洞详情

## 影响

## 概念证明

## 使用的工具

人工审查

## 推荐的缓解步骤

一个好的标题可以帮助评委抓住核心思想，这里是一个好的标题的例子： "[参与者] 可以 [影响] 通过 [条件]"

标题必须简短，否则它的目的就会失去。

复制有行号的内容

如果你使用的是VSCode，这对你的报告来说非常重要。它允许你连同行号和文件相对路径一起获取代码片段，只需点击一下！ 有关更多信息，请查看我之前的帖子：https://twitter.com/InfectedCrypto/status/1803420953512206600

此外，你可能会对我对 Copy With Line Number 扩展所做的 快速修改 感兴趣，以节省更多时间。

WeAudit

该扩展由 @trailofbits 开发，也是每个 SR 的必备工具。在所有功能中，有一项对报告非常实用：你可以轻松地获取指向代码特定部分的链接！

更多信息请见：weAudit Vscode 扩展

Diff 块

报告的推荐部分通常包含与基础实现相比的修改 diff。 通过阅读大量报告，我注意到很多人似乎不知道这一点。 通过将代码包裹在 ```diff ... ``` 代码块中，你将获得这些非常实用的颜色：

如果你想制作更好的 diff，如下图所示，你可以通过以下步骤将更新后的代码与原始竞赛代码库进行 diff：

添加名为 'original'（或你喜欢的名称）的比赛远程仓库及其 URL。

git remote add original https://github.com/project/contest-repo.git

从远程仓库下载对象和引用

git fetch original

打印原始文件和你的修改之间的 diff

git diff original/main -- src/contract.sol

添加图片

你还可以将图片添加到你的提交中，为此，你可以使用一个简单的技巧。 在 GitHub 中向评论/文本字段添加图片会生成图片链接（图片托管在 GitHub 服务器上），然后你可以在提交中使用该链接。

Github 增强评论

最后，出于适度使用的考虑，因为这有时会显得“过于”丰富，你可以尝试特别的 GitHub Markdown “警告”，这些可以在某些情况下极大地增强可读性！

好吧，结束了。现在去写你的报告吧，我打赌你有一些内容可以从一点调味中受益 🍜🧂

• 原文链接： github.com/InfectedIsm/B...
• 登链社区 AI 助手，为大家转译优秀英文文章，如有翻译不通的地方，还请包涵～