欢迎!👋🏼
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 data/generated.sample.json data/generated.json
$ cp data/tags.sample.json data/tags.json
- 构建前端应用并启动开发服务器。
$ bun install # 安装依赖
$ bun dev # 启动开发服务器
应用应该会在您的浏览器中打开。