Skip to content

Commit ba8ca81

Browse files
committed
【初始】添加长论文撰写教程
- 新增中文和英文版本的长论文撰写教程文档 - 添加 GitHub Actions 部署配置文件 - 包含文档格式优化、文档撰写、结果润色等步骤 - 提供 HTML 到 DOCX 转换示例 - 附带 CC BY-SA 4.0 国际许可证
0 parents  commit ba8ca81

9 files changed

Lines changed: 7232 additions & 0 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: 部署文档到 GitHub Pages
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
7+
concurrency:
8+
group: "pages"
9+
cancel-in-progress: true
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
jobs:
17+
deployment:
18+
runs-on: ubuntu-latest
19+
env:
20+
TZ: Asia/Shanghai
21+
steps:
22+
23+
- name: 检出仓库
24+
uses: actions/checkout@v4
25+
26+
- name: 删除不需要部署的文件
27+
run: |
28+
rm -rf parts/
29+
rm -rf .gitHub/
30+
rm 报告模板.html
31+
32+
- name: 部署 markdown.html
33+
uses: PJ-568/MARKDOWN.HTML@v1.11.1
34+
35+
- name: 配置 Pages
36+
uses: actions/configure-pages@v4
37+
38+
- name: 上传 Pages Artifact
39+
uses: actions/upload-pages-artifact@v3
40+
with:
41+
path: '.'
42+
43+
- name: 部署到 GitHub Pages
44+
uses: actions/deploy-pages@v4

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# 贡献指北
2+
3+
## 项目版本管理
4+
5+
我们使用[语义化版本](https://semver.org/lang/zh-CN/)进行版本管理。
6+
任何对代码库的更改都不应使用现有版本发布。
7+
8+
## 提交信息格式
9+
10+
提交信息应遵循 [PJ568 提交说明规范](https://github.com/PJ-568/git-commit-regulation)
11+
12+
## 提交更改
13+
14+
1. Fork 此仓库,在您的仓库新建一个基于此仓库默认分支(branch)的分支。
15+
2. 在该新建分支对项目进行更改,确保语法不存在问题后应用更改您的仓库。
16+
3. 向我们的仓库提交拉取请求。请确保您遵循了上述说明。
17+
4. 我们将定期审查拉取请求,并告知您我们的问题以及在合并您的拉取请求之前需要进行的任何更改。
18+
5. 我们希望您在 15 日内作出回应,之后如果没有显示活动,您的拉取请求可能会被关闭。
19+
20+
### 参考流程
21+
22+
1. Fork 源码,下载到本地并运行项目;
23+
2. 添加或修改代码;
24+
3. 对相关改动进行全面的自我测试;
25+
4. 确认无误后提交修改到 Github;
26+
5. 提交 Pull Request。
27+
28+
### 注意事项
29+
30+
- 单次 Pull Request 不应提交过多修改,请确保每次提交都针对特定的功能且务必说明本次改动的具体目的,例如:修复某 bug 、优化某方法 等,方便进行 Code Review;
31+
- 对于 bug 的修复,应该将本次 Pull Request 和相对应 bug 的 issue 关联起来,让别人知道该问题已经被修复;
32+
- 对于较大的新功能,你需要先提交 Issues,例如 “【新增】添加 XXX 功能”,确认该功能有被添加的必要后,再开始工作;
33+
- 对于一些主观的样式、交互逻辑调整:如颜色、图标的使用,某些预设配置的增减修改等,一般不予通过。但可以在 Discussions 中进行讨论;
34+
- 其他如简单的代码优化、文档修正等,只要修改合理都会被接受。

0 commit comments

Comments
 (0)