Skip to content

Commit 8b15291

Browse files
committed
upload contributing.md
1 parent b85582f commit 8b15291

6 files changed

Lines changed: 96 additions & 2 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: 文章投稿
3+
about: 向我们的网站投稿文章
4+
title: '[Article] '
5+
labels: article
6+
---
7+
8+
<!--
9+
你可以在这里添加你的 PR 描述,介绍你的文章内容和亮点,或者其他你想让我们知道的信息。
10+
11+
如果该文章是转载的文章,你应该在这里注明原作者和授权信息,否则不予合并。
12+
-->
13+
14+
---
15+
16+
<!--
17+
- 请确认您的 PR 符合《投稿指南》中的要求,然后勾选下方的复选框,不要修改其它内容
18+
勾选案例:- [x]
19+
-->
20+
21+
<!--Checkmate-->
22+
23+
- [ ] 我已阅读并检查,此 PR 符合 [投稿指南](https://github.com/HZMath/HZMath.github.io/blob/master/CONTRIBUTING.md) 中的要求

CONTRIBUTING.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# 投稿指南
2+
3+
我们欢迎所有数学爱好者向我们投稿文章!
4+
内容包括但不限于题目的分析求解、套题上传,
5+
以及其他与数学相关的内容.
6+
7+
## 投稿流程
8+
9+
一般地, 投稿者需要先 fork 本仓库, 然后在自己的仓库中编写文章,
10+
最后开启 Pull Request 向我们提交文章.
11+
12+
我们的社干会尽快审核并合并您的文章.
13+
14+
如果你不了解 Git 操作, 你也可以通过邮件将稿件发送至 [邮箱](mailto:hyzxmath@outlook.com), 由社干代为提交.
15+
在收到邮件后我们尽快处理并发送回复邮件通知审核结果, 或者你直接在 Pull Request 页面查看审核进程.
16+
17+
> [!IMPORTANT]
18+
> 本协会的审核工作由学生干部利用课余时间完成,无法保证实时处理, 导致我们的审核周期比较长, 可能一两天甚至几周, 请耐心等待 awa
19+
20+
```mermaid
21+
graph TD
22+
23+
O[投稿方式] --> A[邮件投稿]
24+
A --> B[社干代为提交 PR]
25+
B --> C{审核 PR}
26+
C -->|通过| D[合并 PR, 文章发布]
27+
C -->|需要修改| E[按要求修改 PR]
28+
E -->|修改通过| D
29+
C -->|拒稿| P[Close PR, 发送拒稿邮件]
30+
31+
O --> F[GitHub Pull Request]
32+
F --> G[Fork 仓库、撰写文章、提交 PR]
33+
G --> C
34+
```
35+
36+
## 内容要求
37+
38+
1. 文章内容应该与数学相关
39+
2. 文章内容应该为原创, 或者已经获得原作者授权
40+
- 转载的文章***必须***特别在 Markdown Front Matter 的 license 字段和 PR 描述内注明授权信息
41+
3. 投稿文章***必须***放到 `content/external` 目录下
42+
43+
## PR 要求
44+
45+
1. 一个 PR 一件事:
46+
- 如果是发布文章, 那么一个 PR 一篇文章
47+
- 如果是修改信息, 那你可以一个 PR 同时修改多篇文章
48+
2. PR 标题需要有 `[Article]` 前缀
49+
3. 仅接受 Markdown (.md) 文件.若你希望提交 latex 文件, 请确保勾选 `Allow edits from maintainers`, 我们将协助转换, 但转换结果需经你确认
50+
4. ***必须***勾选 PR 模板中的复选框, 确认你的 PR 符合本贡献指南中的要求, 未勾选的 PR 不予合并
51+
52+
## Front Matter 模板
53+
54+
```markdown
55+
---
56+
title: 文章标题
57+
description: 文章简介
58+
author: 你的名字
59+
date: 2024-01-01
60+
license: "CC BY-SA 4.0" # 转载文章必须注明授权信息
61+
categories: # 仓库内有所有可用的 tags 和 categories 的列表
62+
- Contest
63+
tags:
64+
- 数论
65+
- 解题技巧
66+
---
67+
68+
这里是文章正文...
69+
请使用 Markdown 语法编写你的文章内容
70+
```

config/_default/params.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Pages placed under these sections will be shown on homepage and archive page.
2-
mainSections = ["post"]
2+
mainSections = ["post", "external"]
33
# Output page's full content in RSS.
44
rssFullContent = true
55
favicon = "img/hz.png"

config/_default/permalinks.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# Permalinks format of each content section
2-
post = "/p/:slug/"
2+
post = "/post/:year/:month/:slug/"
33
page = "/:slug/"
4+
external = "/external/:year/:month/:slug/"

content/external/.gitkeep

Whitespace-only changes.

content/post/articles/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)