diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 0498489..4a2d819 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -2,12 +2,13 @@ ## Supported Versions -Use this section to tell people about which versions of your project are -currently being supported with security updates. +This project is under developing, and we are not ready to release a stable version yet. + ## Reporting a Vulnerability diff --git a/.github/contributing.md b/.github/contributing.md index 2532ed5..4dd37c4 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -1,20 +1,16 @@ -# 欢迎 | Welcome -很荣幸此项目能够受到阁下的青睐, 为了给所有贡献者带来一个愉快的合作氛围, 请所有协作开发者务必遵守以下几项要求. +# Welcome We are honored that this project has been favored by you. In order to bring a pleasant cooperation atmosphere to all contributors, please all cooperating developers must abide by the following requirements. -## 关于 `Commit Message` | About `Commit Message` -希望所有协作者能够遵守规定在 [Crequency 文档中心](https://docs.catrol.cn/rules/team/git/#markdown-header-%E6%8F%90%E4%BA%A4%E6%B6%88%E6%81%AF%E8%A7%84%E8%8C%83) 中的消息规范. +## Commit Message -I hope all collaborators can abide by the regulations in the [Crequency Documentation Center](https://docs.catrol.cn/rules/team/git/#markdown-header-%E6%8F%90%E4%BA%A4%E6%B6%88%E6%81%AF%E8%A7%84%E8%8C%83) in the message specification. +We strongly recommend that all collaborators follow the message specification in the [Git Message Rule](https://docs.crequency.com/norm/git-message/). -## 关于 `Pull Request` | About `PR` -务必在 PR 标题前加入 `[Pull Request]` 字段, 并用空格与标题隔开. +And we also provide commit template file in the root folder of [KitX](https://github.com/Crequency/KitX) repo. -Be sure to include the `[Pull Request]` field before the PR title and separate it from the title with a space. +## Pull Request -## 一些细节 -如果提交的改动没有影响功能, 请在提交消息中[添加字段](https://docs.github.com/cn/actions/managing-workflow-runs/skipping-workflow-runs)以阻止 CI, 建议使用 `[skip ci]`. +We wrote a python script to format pull request title, so you can just write a sentence in the title, and the script will add `[Pull Request]` prefix for you. -If the submitted changes do not affect functionality, please [add field](https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs) in the commit message to block CI, it is recommended to use `[skip ci]`. +Please make sure the title is clear and concise.