提交补丁前要做什么?
====================

首先,这篇文章只是我的记录,大概率并不适用于大部分开源社区,因为我大部分时间也只向 DAMON 贡献。如果想了解通用的开源社区规则的话,去使用 LLM 或在其他网站搜索热门文章大概率是更好的选择。

我不会在本文章中说一些关于代码本身的问题,比如说通过测试、编译成功或静态检查没问题,这些问题很容易修复,因为这些是代码的问题,不是人的问题。

确认问题的真实性
================

最重要的就是确认问题是真实存在的,如果可以的话,提供一个可复现脚本会很方便 Maintainer/Reviewer。

问题是预期行为吗?
------------------

但是,可稳定复现的行为并不直接意味着问题是真实存在的,更重要的是,这是否是一个问题?它是否可能是预期行为?如果无法完全证明(通过 Commit、文档和代码注释)这是一个问题的话,那么最好先向社区内的其他人询问,或者至少在补丁上加上 RFC 前缀。不过,最省大家带宽的方式一定是先问。

问题造成了什么?
----------------

如果问题造成了什么,最好好好地写在邮件上,比如说造成了系统崩溃、用户困惑或其他任何造成的东西。这可以帮助其他人更好地确认这应该怎么修;比如说,如果只是造成用户困惑的话,那么这个问题可能只需要通过添加/改进文档来解决,而不需要改变任何行为。

猜测
====

如果可以的话,尽量不要猜测他人的想法,在猜测后,也应该向他们确认。过度的猜测会导致大家的带宽被无意义的消耗,如果有什么不懂的,先思考,再去问。不要只做事而不询问,大部分时候这样做只会给他人造成困扰。

新机制
======

如果是向内核提供新机制/行为修改的话,应该在 Commit Message 明确地说明为什么要增加这个机制,它在什么场景下表现更好了?可以的话,提供 Benchmark 结果会更好。

如果这只是一个奇妙的想法的话,那么,考虑先提问,或增加 RFC 前缀。但是尽量别在大家都忙的时候去提什么奇妙想法。

Publish: 2026-09-10
Last Change: 2026-09-10
Go Back