欢迎! ??
Good First Issue是一项旨在从热门项目中轻松挑选的项目,因此从未为开源做出过贡献的开发人员可以快速入门。
开源维护者总是希望让更多人参与进来,但新开发人员普遍认为成为贡献者具有挑战性。我们相信让开发人员解决超级简单的问题可以消除未来贡献的障碍。这就是 Good First Issue 存在的原因。
欢迎您在 Good First Issue 中添加新项目,我们鼓励所有项目——新旧、大小。
请按照以下简单步骤操作:
我们的目标是缩小新开源贡献者的项目范围。为了保持 Good First Issue 中的项目质量,请确保您的 GitHub 存储库满足以下条件:
它至少存在三个与good first issue
标签相关的问题。默认情况下,该标签已存在于所有存储库中。如果没有,您可以按照此处的步骤操作。
它至少有 10 名贡献者。
它包含包含项目详细设置说明的 README.md,以及包含新贡献者指南的 CONTRIBUTING.md。
它得到积极维护。
在 data/repositories.toml 中添加存储库的路径(按字典顺序)。
创建一个新的拉取请求。请在 PR 描述中添加指向存储库问题页面的链接。合并拉取请求后,更改将在 goodfirstissue.dev 上生效。
Good First Issue 有两个组件 - 使用 Nuxt.js 构建的前端应用程序和用 Python 编写的数据填充脚本。
要向网站提供新功能和更改,您需要在本地运行该应用程序。请按照以下步骤操作:
将项目克隆到本地。确保您的计算机上安装了 Python 3 和最新版本的 Node.js。
复制示例数据文件以供本地应用程序使用,并将其重命名为应用程序所需的文件名。此步骤很重要,因为如果没有这些数据文件,前端应用程序将无法运行。
$ cp 数据/生成的.sample.json 数据/生成的.json $ cp 数据/tags.sample.json 数据/tags.json
构建前端应用程序并启动开发服务器。
$ Bun install # 安装依赖项 $ Bun dev # 启动开发服务器
该应用程序应在您的浏览器中打开。