Skip to content

Commit

Permalink
[non-related] chore: Refine the introduction and contrib rules
Browse files Browse the repository at this point in the history
Signed-off-by: crrashh1542 <[email protected]>
  • Loading branch information
crrashh1542 committed Jun 22, 2024
1 parent ada1f2d commit 00ad328
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 23 deletions.
19 changes: 13 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,22 @@
🎉 我们热烈欢迎且感谢各位参与本项目的开发工作,目前您可以通过以下方式参与。

## Issues
[Issues](https://github.com/mspcmanager/mspcm-docs/issues) 中提出意见或建议,我们将尽快回复并对项目做出调整。
你可以在 [Issues](https://github.com/mspcmanager/mspcm-docs/issues) 中提出意见或建议,我们将尽快回复并对项目做出调整。

## Pull Requests
如果您要[提交 PR](https://github.com/mspcmanager/mspcm-docs/pulls)我们同样为您的贡献而高兴,不过您需要先了解以下内容,否则您的 PR 暂不予 merge,或要求您修改后 merge
如果你选择[提交 PR](https://github.com/mspcmanager/mspcm-docs/pulls)请先了解以下内容,否则你的 PR 暂不会被合并,或要求修改后合并

1. 请勿提交与管家无关或对管家无故诋毁的内容。
2. 请在提交 commit 时遵守 commit message 的相关规则。您可以参考 → <https://zhuanlan.zhihu.com/p/182553920>
* 错误范例:新增内容
* 正确范例:docs: 新增内容
2. 请在提交 commit 时遵守本项目的 [commit message 相关规则](#commit-message-规则)
3. 对于文档中的内容,请在中英文之间打上空格以保持美观。
4. 请遵守一定的文件/代码内命名规则,如驼峰命名法。
5. 转载相关文献时遵守一定的规定。
5. 转载相关文献时遵守其协议。

## Commit Message 规则
本项目的 commit message 要求必须分为三段,以下是一个标准的 commit message 实例:

[en] appendix: Correct a grammer mistake in repair-system-image

* 第 1 段:要求用半角方括号包裹住修改内容所属的语言。如果与文档内容无关(如更正配置等),请将其改为 `[non-related]`,这种 commit 的 commit message 的后文不受下述规则的限制。
* 第 2 段:要求写出修改内容所属文件的目录。如果该文件在根目录,则直接写其不带扩展名的文件名。
* 第 3 段:要求用一句英语简短地概述你所做的更改。
37 changes: 20 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,37 @@
# 微软电脑管家使用文档
![微软电脑管家 3.0](https://pcmanager.microsoft.com/assets/digitalLivingMain-phone.png)

![协议](https://img.shields.io/badge/License-CC_BY--NC--SA_4.0-blue)
![ci 状态](https://img.shields.io/github/actions/workflow/status/mspcmanager/mspcm-docs/deploy-to-pages.yml)
# Microsoft PC Manager Docs
![Microsoft PC Manager 3.0](https://pcmanager.microsoft.com/assets/digitalLivingMain-phone.png)

[简体中文](./README.zh-cn.md) |
![License](https://img.shields.io/badge/License-CC_BY--NC--SA_4.0-blue)
![CI Status](https://img.shields.io/github/actions/workflow/status/mspcmanager/mspcm-docs/deploy-to-pages.yml)

### 👏 介绍 / Introduction
这是 **Microsoft 官方**出品的电脑辅助软件「微软电脑管家」的使用文档,能够在你使用产品遇到问题时提供一点帮助。欢迎前往 <https://pcmanager.microsoft.com> 下载并体验最新版微软电脑管家!
### 👏 Introduction
This is an unofficial document of Microsoft PC Manager, a PC assistant produced by **Microsoft Corporation**, and we hope this may provide some help when you're meeting problems with Microsoft PC Manager. Visit <https://pcmanager.microsoft.com> for the latest Microsoft PC Manager! 😉

注意:这并不是微软及其子公司官方组织编写的文档,文档编写者并非微软及其子公司的员工,本文档中的内容也与微软及其子公司本身无关。**本文档基于 [CC BY-NC-SA 4.0 协议](https://creativecommons.org/licenses/by-nc-sa/4.0/),请转载或参与其它涉及本项目的活动时,遵守协议的规定。**
> [!IMPORTANT]
> We are not organized by Microsoft Coporation or its subsidiaries to write this document, and are not employees of Microsoft Coporation or its subsidiaries. **This document is released under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) license, thus please obverse the license when reprinting or participating in other activities that involve this document.**
本文档基于 [VitePress](https://vitepress.dev/zh/) 进行构建,您可以在我们的 [GitHub Pages](https://mspcmanager.github.io/mspcm-docs/) 上查看最新已构建好的文档。
This document is built on [VitePress](https://vitepress.dev/), and you can view it on our [GitHub Pages](https://mspcmanager.github.io/mspcm-docs/).

_* 请注意,本文档部分内容引用了来自第三方(即非 Microsoft 官方)网页的链接。这些网页似乎提供了准确、安全的信息以帮助您解决问题。但是,请仍然留意网页中推广的通常被归类为 PUP(Potentially Unwanted Products,潜在有害产品)的广告。在您下载及安装文件或应用前,请彻底地研究网页中推广的任何产品。_
> [!NOTE]
> Parts of this document refer to links from third-party (i.e., non-official Microsoft) web pages. These pages appear to provide accurate and safe information to help you solve your problem. However, please remain aware of ads promoted on these pages that are often categorized as PUPs (Potentially Unwanted Products). Before downloading and installing a file or application, please thoroughly research any products promoted on the page.
### 📣 参与注意 / Tips
详情见 [CONTRIBUTING.md](./CONTRIBUTING.md)
### 📣 Tips
See details in [CONTRIBUTING.md](./CONTRIBUTING.md)

### 🖥️ 本地部署文档 / Deployment
a. 首先,请确保你的计算机中安装了 Node.js(18 LTS 或 20 及更高版本)。
### 🖥️ Deployment
a. Make sure that Node.js (v18 LTS or v20 and later) has been installed on your PC.

b. 将源码 clone 到本地:
b. Clone the repo.
```shell
git clone https://github.com/mspcmanager/mspcm-docs
```
c. 安装 PNPM 和项目依赖的模块:
c. Install PNPM and dependencies of this repo.
```shell
npm install pnpm -g
pnpm install
```
d. 启动开发环境,作出你的修改,再启动生产模式以构建静态页面:
d. Start the development env and do some changes, and then start production env for building static pages.
```shell
pnpm dev
pnpm build
Expand Down
36 changes: 36 additions & 0 deletions README.zh-cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# 微软电脑管家使用文档
![微软电脑管家 3.0](https://pcmanager.microsoft.com/assets/digitalLivingMain-phone.png)

[English](./README.md) |
![协议](https://img.shields.io/badge/License-CC_BY--NC--SA_4.0-blue)
![ci 状态](https://img.shields.io/github/actions/workflow/status/mspcmanager/mspcm-docs/deploy-to-pages.yml)

### 👏 介绍
这是 **Microsoft 官方**出品的电脑辅助软件“微软电脑管家”的非官方使用文档,希望本文档能够在你使用产品遇到问题时提供一点帮助。欢迎前往 <https://pcmanager.microsoft.com> 下载并体验最新版微软电脑管家!😉

注意:这并不是微软及其子公司官方组织编写的文档,文档编写者并非微软及其子公司的员工,本文档中的内容也与微软及其子公司本身无关。**本文档基于 [CC BY-NC-SA 4.0 协议](https://creativecommons.org/licenses/by-nc-sa/4.0/),请转载或参与其它涉及本项目的活动时,遵守协议的规定。**

本文档基于 [VitePress](https://vitepress.dev/zh/) 进行构建,你可以在我们的 [GitHub Pages](https://mspcmanager.github.io/mspcm-docs/zh-cn/) 上查看最新已构建好的文档。

_* 请注意,本文档部分内容引用了来自第三方(即非 Microsoft 官方)网页的链接。这些网页似乎提供了准确、安全的信息以帮助你解决问题。但是,请仍然留意网页中推广的通常被归类为 PUP(Potentially Unwanted Products,潜在有害产品)的广告。在您下载及安装文件或应用前,请彻底地研究网页中推广的任何产品。_

### 📣 参与注意
详情见 [CONTRIBUTING.md](./CONTRIBUTING.md)

### 🖥️ 本地部署文档
a. 首先,请确保你的计算机中安装了 Node.js(18 LTS 或 20 及更高版本)。

b. 将源码 clone 到本地:
```shell
git clone https://github.com/mspcmanager/mspcm-docs
```
c. 安装 PNPM 和项目依赖的模块:
```shell
npm install pnpm -g
pnpm install
```
d. 启动开发环境,作出你的修改,再启动生产模式以构建静态页面:
```shell
pnpm dev
pnpm build
```

0 comments on commit 00ad328

Please sign in to comment.