Skip to content

Commit

Permalink
docs: Add CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
Jerremiz committed Sep 30, 2024
1 parent af64464 commit 4ed9b3d
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 3 deletions.
19 changes: 19 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## 编辑前须知

首先,感谢您愿意为 **华师手册** 做出贡献。

请您在提交拉取请求(Pull Request)前,我们需要您了解并熟知 **[如何参与](https://scnusw.online/intro/htc/)****[格式手册](https://scnusw.online/intro/format/)** 里的内容。

如果有关内容**尚未完成**,请考虑先新建 issue 或本次作为 draft pr 提交。

如果内容**已经完成**,您无需新建 issue ,但仍需要核对 **[格式手册](https://scnusw.online/intro/format/)** 提到的基本格式要求。在 **[预览网页](https://preview.scnusw.online)** 构建完成后,建议您检查实际效果,并持续跟进审核或修改意见。

在提交 pull request 时,确保**您已知晓**

+ 请在回应建议、问题或 pull request 之前仔细阅读,并详细说明自己的看法,以免引起不必要的误会。

+ 请跟进您的 pull request。如您的 pull request 长时间没有回应修改请求,可能会被直接关闭。

???+ 敬请留意
- 请您记得在文件头的 author 字段后方留下你的署名
- 在致谢页 `ack.md` 中的贡献者部分,可附上指向您个人的链接
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- [ ] 我已认真阅读 **编辑前须知** ,并遵循了[如何参与](https://scnusw.online/intro/htc/)[格式手册](https://scnusw.online/intro/format/)的相应规范。
- [ ] 我已阅读 **[贡献指南](https://github.com/SCNU-SW/SCNU-SW-Online/blob/main/.github/CONTRIBUTING.md)** **[社区公约](https://github.com/SCNU-SW/SCNU-SW-Online/blob/main/CODE_OF_CONDUCT.md)** ,并遵循了 **[如何参与](https://scnusw.online/intro/htc/)****[格式手册](https://scnusw.online/intro/format/)** 的相应规范。

<!-- 完成内容后,将上述 [ ] 替换为 [x]。 -->

Expand Down
4 changes: 2 additions & 2 deletions docs/edit-landing.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ description: 编辑华师手册前需要了解的注意事项和步骤。

首先,感谢您愿意为 **华师手册** 做出贡献。

请您在提交拉取请求(Pull Request)前,我们需要您了解并熟知 [如何参与](./intro/htc.md)[格式手册](./intro/format.md) 里的内容。
请您在提交拉取请求(Pull Request)前,我们需要您了解并熟知 **[如何参与](./intro/htc.md)****[格式手册](./intro/format.md)** 里的内容。

如果有关内容**尚未完成**,请考虑先新建 issue 或本次作为 draft pr 提交。

如果内容**已经完成**,您无需新建 issue ,但仍需要核对 [格式手册](./intro/format.md) 提到的基本格式要求。在 [预览网页](https://preview.scnusw.online) 构建完成后,建议您检查实际效果,并持续跟进审核或修改意见。
如果内容**已经完成**,您无需新建 issue ,但仍需要核对 **[格式手册](./intro/format.md)** 提到的基本格式要求。在 **[预览网页](https://preview.scnusw.online)** 构建完成后,建议您检查实际效果,并持续跟进审核或修改意见。

在提交 pull request 时,确保**您已知晓**

Expand Down

0 comments on commit 4ed9b3d

Please sign in to comment.