quick-start.md

title	slug	tags	description
快速入门	/quick-start	快速入门	Coming soon!

:::tip 阅读本文预计需要 ⏱ 3 分钟。

:::

欢迎使用开源指南针，通过这篇文章，你将在三分钟内快速了解开源指南针。并为你的项目获得相应的洞察分析报告。

查看分析报告

你可以通过网站主页搜索开源项目或开源社区的数据报告。

提交项目分析请求

如果你没有找到你想要的分析，你可以通过网站右上角的「提交项目分析」按钮提交分析请求。

你可以选择 GitHub 或 Gitee 授权登录来提交项目分析请求。

登录帐号后，你可以根据需要提交单个代码仓库或单个社区的分析请求。

• 单仓项目：聚焦于单个开源代码仓库的数据洞察力，以单个的 Git 代码仓库作为分析对象。
• 社区项目：将开源社区作为分析对象，侧重于社区发展过程中的数据洞察力。

以单仓项目形式提交

1. 你可以通过界面选择授权的代码仓库，或者手动输入 Git 代码仓库地址。
2. 如果你想要更新你授权的组织列表，请单击下拉菜单中的授权选项以更新授权。
3. 当然，你也可以手动填写你想要提交分析的 Git 代码仓库地址。

以社区项目形式提交

1. 点击「提交社区项目」，切换到社区项目分析请求页面。
2. 你可以通过界面选择授权的代码仓库，或者手动输入 Git 代码仓库地址以添加你的软件制品仓库。
3. 在表单底部输入对应的社区名称。
4. 此外，你还可以从社区添加一个治理仓库。当然，这是一个可选项。

如果你想要更新你授权的组织列表，请单击下拉菜单中的授权选项以更新授权。

查看项目分析请求进度

项目分析请求将在我们指定的仓库下创建一个 Pull Request。你可以在 Pull Request 中检查分析报告的处理进度。

提交完成后，你可以通过开源指南针在 GitHub 或 Gitee 上的分析报告仓库跟踪分析报告的进度。

:::info 你可以点击此进行访问

https://github.com/oss-compass/compass-projects-information/pulls

:::