贡献指南_1

This commit is contained in:
Kamisato-Ayaka-233 2023-02-13 20:01:50 +08:00
parent b3021c4164
commit 6bba08cba9

52
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,52 @@
# 米哈游API收集
你好这里是mihoyo-api-collect社区贡献指南。本文主要面向想向本仓库贡献文档的用户。
---
## 项目定义
米哈游API收集mihoyo-api-collectMhyAC项目是一个仅用于学习与研究、社区开源、公益性质的与[米哈游](https://www.mihoyo.com/)旗下应用与游戏的API应用程序接口文档使用CC-BY-NC 4.0协议开源。它将无差别收集整理所有相关的接口。
## 基础
该项目始终使用[Markdown](https://markdown.com.cn/)格式进行书写。
文档索引按照业务类型及功能以**路径、文件**索引。
任何用户都可通过拉取请求Pull Request提供自己分析出的接口地址与其使用说明。
## 标题、文件夹与路径结构
### 标题
在[README.md](README.md)目录下的标题用于分类米哈游不同的应用、游戏的API。
### 文件夹
文件夹层级应当与[README.md](README.md)的目录一致,文档均存放于项目根路径的文件夹中,文件夹命名统一使用英文,如`原神`为`genshin_impact`,米游社为`hoyolab`。
2级、3级……文件夹应当存在其对应[README.md](README.md)目录的2级、3级……
### 文件
文档目录以**列表**形式在[README.md](README.md)中,使用缩进标识文档的层级,例如,`米游社`下有`用户`分类,其下又有例如`用户信息`、`用户游戏信息`等文档链接。文件名命名统一使用英文。
## 文档内容格式
注:文档格式可根据实际情况进行调整。
### 文档头部
文档的首行使用**1级标题**,描述这篇文档是属于哪一类别的。
标题下方为**文档目录**,与正文中的**2级标题**对应。该目录使用**列表**与缩进,每项使用**超链接**实现点击跳转到对应标题。
例子:
```md
#
```