FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [View Raw Code]   [Original HTTPS Page]

linux-command/CONTRIBUTING.md at master · heylumen/linux-command · GitHub

  1. heylumen
  2. linux-command

Repository navigation

Breadcrumbs

  1. linux-command

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (38 loc) · 1.54 KB

Breadcrumbs

  1. linux-command

CONTRIBUTING.md

File metadata and controls

60 lines (38 loc) · 1.54 KB
Raw

贡献者约定

感谢您对本项目提交贡献，为了便于维护者管理，请各位维护人员遵循以下约定

如果您希望提交一个命令

命令的存放位置在 ./command/ 文件夹中

  1. 在这里创建一个 [CommandName].md 文件，比如 pacman.md
  2. 打开文件，键入指令在终端中执行的命令
  3. 第二行输入三个等号
  4. 创建二级标题“补充说明”，并且在这个标题下面创建至少下面几个三级标题
    • 语法
    • 选项
    • 参数

按照预期，文档应该是这样的

CommandName
===
作为代码规范文档进行展示

## 补充说明

**CommandName命令** 是用于演示的文档

### 语法

(具体编写文档时，请使用 shell 代码块包裹以下内容)

CommandName <-abcdABCD> <必选参数> [可选参数]

### 选项

(具体编写文档时，请使用 shell 代码块包裹以下内容)

-a xxxxx
-b xxxxx
...
-C xxxxx
-D xxxxx

### 参数

(具体编写文档时，请使用 shell 代码块包裹以下内容)

可选参数：一般情况下可以不给出

如果您希望维护前端页面

  • 请确保您的代码可以完整的运行在最新的 Chromium 和 Safari 浏览器 (#489)

对于提交信息的其他规范

Back | FazBrowse Home | New Git URL