mihoyo-api-collect/CONTRIBUTING.md
Kamisato-Ayaka-233 6bba08cba9 贡献指南_1
2023-02-13 20:01:50 +08:00

1.8 KiB
Raw Blame History

米哈游API收集

你好这里是mihoyo-api-collect社区贡献指南。本文主要面向想向本仓库贡献文档的用户。


项目定义

米哈游API收集mihoyo-api-collectMhyAC项目是一个仅用于学习与研究、社区开源、公益性质的米哈游旗下应用与游戏的API应用程序接口文档使用CC-BY-NC 4.0协议开源。它将无差别收集整理所有相关的接口。

基础

该项目始终使用Markdown格式进行书写。

文档索引按照业务类型及功能以路径、文件索引。

任何用户都可通过拉取请求Pull Request提供自己分析出的接口地址与其使用说明。

标题、文件夹与路径结构

标题

README.md目录下的标题用于分类米哈游不同的应用、游戏的API。

文件夹

文件夹层级应当与README.md的目录一致,文档均存放于项目根路径的文件夹中,文件夹命名统一使用英文,如原神genshin_impact,米游社为hoyolab

2级、3级……文件夹应当存在其对应README.md目录的2级、3级……

文件

文档目录以列表形式在README.md中,使用缩进标识文档的层级,例如,米游社下有用户分类,其下又有例如用户信息用户游戏信息等文档链接。文件名命名统一使用英文。

文档内容格式

注:文档格式可根据实际情况进行调整。

文档头部

文档的首行使用1级标题,描述这篇文档是属于哪一类别的。

标题下方为文档目录,与正文中的2级标题对应。该目录使用列表与缩进,每项使用超链接实现点击跳转到对应标题。

例子:

#