Hacknet-Extension-Tutorial

commit

43e56f0

parent

e596df0

author

BovineBeta

date

2023-05-02 20:15:33 +0000 UTC

repo+: [CONTRIBUTING]首次规范

 1@@ -0,0 +1,60 @@
 2+# Contributing Guidelines
 3+
 4+欢迎来到这个项目! 感谢您的关注并欢迎您的贡献. 为确保每个人都能有效协作, 我们要求您在向此存储库贡献代码时遵循这些准则. 
 5+
 6+## Git Commit Guidelines
 7+
 8+请以以下格式进行commit:
 9+~~~
10+更改类型: [文档标题]内容
11+~~~
12+
13+项目的文档有关的标题可以只保留3个字母, 峰驼单词可以只取大写字母. 如`Nodes`为`[Nod]`, `HackerScript`为`[HS].
14+
15+更改类型如下: 
16+- docs 对与项目的文档有关的修改
17+- - : 更改
18+- - +: 创建
19+- - -: 删除
20+
21+- assets 对媒体的修改
22+- - : 更改
23+- - +: 创建
24+- - -: 删除
25+
26+- repo 对仓库/项目定义的文本修改, 如`.gitignore`与`.github/ISSUE_TEMPLATE/xx.md`.
27+- - : 更改
28+- - +: 创建
29+- - -: 删除
30+
31+
32+## Example
33+假如提交对介绍`Action`的文档中的内容进行完善的改变, 则commit内容如下:
34+~~~
35+docs: [Act]完善了什么什么
36+~~~
37+假如创建了`.gitignore`, 内容为`.vscode/`, 则commit内容如下:
38+~~~
39+repo+: [gitignore]添加了.vscode
40+~~~
41+假如改变内容为对介绍`Nodes`的文档中的"守护进程"内容进行完善, 并且附加了部分媒体, 则应该分别提交. commit内容如下:
42+~~~
43+assets+: [Nod]添加了部分守护进程的图片
44+~~~
45+~~~
46+docs: [Nod]完善了守护进程
47+~~~
48+
49+## Assets Guidelines
50+媒体内容应该按照以下标准来存放:
51+
52+假如文档为:
53+~~~
54+目录/文件名.md
55+~~~
56+则它的媒体文件应该存放于:
57+~~~
58+Assets/目录/文件名/
59+~~~
60+
61+在文中媒体内容应该使用相对路径引用, 这样方便于阅读器找到相应媒体.