贡献指南
序言
欢迎您来!
本站为 JSUTXCPC 博客兼文档系统,这里收录了同学们可能需要的内容,我们强烈建议同学们先阅读完一些文档后再进行投稿创作。
参与贡献(简单流程)
你可以先阅读一些高优先级项目,或者你可以上传自己的笔记,本站支持 LATEX 公式渲染。
如果你决定要贡献,请按照下面的步骤进行:
- 步骤 1
前往江苏理工开源社区:https://git.jsut.site/ 注册账号。注册完账号之后,你就可以参与评论,编辑页面操作。
- 步骤 2
(可选操作)电脑安装 git,我们非常建议您学会 git 工作流,虽然可选但是建议。
- 步骤 3
派生项目:https://git.jsut.site/team-xcpc/acmblog,然后你可以选择使用 ssh 或 http 克隆仓库到本地进行修改。
你也可以通过页面最下方的编辑页面直接修改,审核一般 1 到 3 天左右
- 步骤 4
建议阅读:https://theme-plume.vuejs.press/guide/intro/,进行贡献。或者善用评论功能添加页面需求。
直接参加贡献,会自动以你的用户名添加到贡献者名单内。当然如果你选择进行联系我们邮箱投稿,那可能不会自动生成贡献者,所以我们十分推荐你使用学校开源社区进行贡献!
贡献方案
使用本地开发工具
你可以在本地查看网页,使用 Node.js 最新版本并安装 pnpm 包管理项目,首先使用 git 工具对该项目进行克隆,然后根据自己的实际情况修改,注意如果查无此邮箱,那么在此域下无法显示你的贡献。
git clone ssh://[email protected]:17030/team-xcpc/acmblog.git
cd acmblog
git config user.name "Your Name" # 改成自己的用户名
git config user.email "[email protected]" # 改成自己的邮箱然后安装 pnpm 工具在本目录下进行如下的操作,如果你网络速度较慢,可以使用 pnpm config set registry https://registry.npmmirror.com/ 设为国内镜像。
最后执行,就可以完成本地的部署,在本地查看页面并更改。
pnpm i
pnpm run docs:dev # ctrl + c 可以终止进程注意
请在新建文件的时候确定你的投稿是地址是正确的,举个例子,你想投稿到 算法 -> 算法笔记,那么对应的文件在 docs/algo/1.算法笔记 下,详见下面的文件树。此外,请保证 pnpm run docs:dev 是运行状态!
docs
.vuepress
...
algo算法文档目录
1.算法笔记
your_algo_doc.md
2.算法模板
...
3.比赛题解
...
blog博客文档目录
...
survive生存指南文档目录
...
README.md
下面是运行状态的 pnpm,这样在创建文件的时候会自己编写合理信息,例如 front-matter:
❯ pnpm run docs:dev
> 江苏理工网络与xcpc社团@1.0.0 docs:dev /Users/tim/development/blog/acmblog
> vuepress dev docs
✔ Initializing and preparing data - done in 4.10s
vite v7.1.12 dev server running at:
➜ Local: http://localhost:8080/
➜ Network: http://192.168.128.60:8080/
➜ Network: http://192.168.3.1:8080/
➜ Network: http://198.18.0.1:8080/
➜ Network: http://192.168.2.1:8080/直接更改
如果需要修改而不是新建页面,可以直接在页面底部的更改页面直接进行修改。
提交pr
派生分支后,投稿到 main 分支使用 pull request 功能进行合并请求。
