贡献须知
关于文件组织
-
当您想要新增一个课程时,请在项目根目录创建一个以该课程全名为名的文件夹,并在其中新建
README.md文件。并在文件中加入一个一级标题,内容为课程名称。如您新增一个名为Investment的课程,就在README.md文件中写入如下一行```
Investment
```
然后您可以在其中留下一些课程心得和学习建议(也可以不写)。
-
当您向仓库内某一个课程增添资料时,请注明资料的性质(如notes/assignment/quiz/);并写明您是什么时候学习该课程。例如您准备贡献2024年上学期某课程的assignment,那么就请您在相应课程文件夹下新建名为
Assignments 24fall的文件夹。并将资料放于其中。
贡献内容的操作流程
您可以通过两种途径向项目贡献资料或经验:发起Pull Request,或向管理员邮箱发邮件,并在主题中注明FM课程攻略。
如何发起Pull Request
-
首先Fork本项目,点击右上角的Fork按键即可。
-
上传文件到已有文件夹:打开对应文件夹,点击
Add files,在下拉菜单中选择Upload files。在上传之前请留意一下项目的文件组织。请注意在每一次上传操作前都要点击主页面中sync fork按钮,以保持与母仓库的版本一致,否则管理员可能无法处理您的提交 -
将您想要上传的资料(可以是一个或几个文件,也可以是整个文件夹)拖拽到页面对应区域中。然后填写本次提交的主题和详细说明(分列在两个输入框中,跟邮件的主题和正文很像)。,在提交时注明自己添加的课程名称和课程代码,并描述您本次提交对项目做出的更改。
-
提交 PR:上传完文件到个人仓库之后,点击
Contribute即可。