CONTRIBUTING.md

为 RSSBook 贡献

This document is also available in English.

本文档指导你如何为 RSSBook 项目贡献，包括如何创建新的 Feed 源，如何提交公开实例列表以及如何提出 Issue/Pull Request。

路由规则

在编写 Feed 之前，请你务必阅读以下规则，以确保你的 Feed 符合要求。

命名规范

1. slug 命名建议使用网站的域名或简短的标识符，只有小写字母、数字和中划线（-），不能包含空格或其他特殊字符。

路径规范

1. 路径只有

处理函数规范

1. 你的处理函数应该是异步的（async 标注的），并且返回一个符合 Data 类型的数据对象。
2. 你的处理程序在获取外部资源时，应该使用 ofetch 方法，但是它会在请求错误时抛出异常，你需要使用 try catch 来处理这些异常。
3. 在大多数情况下，你应该使用解构赋值来获取需要的参数和工具函数，以便更方便地编写 Feed 逻辑。

提交公开实例列表

我们希望 RSSBook 是供大家使用的工具，如果你部署了 RSSBook 的公开实例，欢迎你将你的实例添加到我们的 公开实例列表 中。

HOSTS 文件使用简单的 CSV（Comma-Separated Values，意为用逗号分隔值）格式，每一行代表一个公开实例。

你需要提供你的实例的 URL 和简短描述。你的实例 URL 应该是一个可以公开访问的域名，而且支持 HTTPS 协议。在描述中，你需要列出你的版本信息（可以在 package.json 或 OpenAPI 文档中找到），以及一段铿锵有力的描述（但是不要有逗号），鼓吹你的实例（或许还可以有你）。

Tip

我们建议你的实例可以与上游的 RSSBook 项目保持同步，以便获得最新的功能和修复。

然后，你可以提交将你的实例添加到 HOSTS 文件中。

如果审核通过，我们会将你的实例添加到列表中，然后在所有 OpenAPI 文档中显示。