解决开放源代码项目中的错误,发出或请求请求的正确方法?

时间:2019-07-15 15:27:40

标签: git github open-source

在Github上有一个开源项目,我在其中发现了一个小错误,并通过一个小而简单的更改就解决了。

该项目没有CONTRIBUTING文件。

为该项目做贡献的最佳方法是什么?我应该使用不含错误的代码发出请求请求,还是应该创建一个问题,说明问题并提出解决方案?

1 个答案:

答案 0 :(得分:1)

这实际上取决于项目和您要进行的更改的类型。

如果更改是简单明了且明显正确的(例如,以前有一个明显的错误已被打破,而现在不再存在此更改),那么通常只需打开拉取请求即可。

如果存在所建议的更改较大的情况(例如,添加新功能或API),维护者想要输入的信息(例如,更新项目贡献文档)或问题更加模糊的情况,那么最好先打开一个问题。维护者可以为您提供您未曾考虑过的方向或替代方案,并可能会在您向您收取费用之前考虑您考虑过他们的意见。

当然,如果项目文档中的说法有所不同,请这样做。

在这种情况下,由于您要添加与项目有关的文档,因此可能会出现问题。也许他们会在提供的文档中拥有他们想要的东西,例如用于安全性问题的电子邮件地址或他们想使用的行为准则,然后您可以征询他们的意见,然后写出解决该问题的PR。