CONTRIBUTING.md · 李鹏达/docs-openmind

# 昇腾众智项目资料贡献指南

- [昇腾众智项目资料贡献指南](#昇腾众智项目资料贡献指南)
    - [贡献者许可协议](#贡献者许可协议)
    - [资料风格](#资料风格)
    - [资料目录结构](#资料目录结构)
    - [Fork-Pull开发模式](#fork-pull开发模式)
    - [报告问题](#报告问题)

## 贡献者许可协议

在你第一次提交代码给昇腾社区之前，需要[签署CLA](https://clasign.osinfra.cn/sign/Z2l0ZWUlMkZhc2NlbmQ=)，对于个体贡献者，请“签署个人CLA”

## 资料风格

为了方便昇腾众智项目资料的审核、维护和开发，请遵循如下规范

我们使用*MarkdownLint*来检查markdown文档的格式。    
    具体细节，请参考[RULES](https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md)。

## 资料目录结构

昇腾众智项目资料的目录结构如下，请在资料开发和维护过程中，保持相应的目录结构风格。

```
docs-openmind
	├── guide                               # 资料内容目录
	│   ├── common                          # 众智项目公共的资料内容
	│   │   ├── figures                     # 图片存放目录，可根据需要规划子目录
	│   │   ├── tutorials                   # 具体资料文档存放目录，可根据需要规划子目录
	│   │   ├── one_stop_navigation.md      # 一站式导航文件，提供公共资料的索引链接
	│   │   └── README.md
	│   ├── sample                          # 子项目资料目录组织形式的参考样例框架
	│   │   ├── figures                     # 图片存放样例目录
	│   │   ├── tutorials                   # 具体指南文档样例目录
	│   │   ├── one_stop_navigation.md      # 一站式导航样例文件
	│   │   └── README.md
	│   ├── xx-project                      # 按业务领域划分的资料内容目录，如cann、mindx等     
	│   │   ├── sub-project-1               # 具体业务的资料内容目录
	│   │   │   ├── figures                 # 图片存放目录，可根据需要规划子目录
	│   │   │   ├── tutorials               # 具体资料文档存放目录，可根据需要规划子目录
	│   │   │   ├── one_stop_navigation.md  # 一站式导航文件，提供具体业务资料的索引链接
	│   │   │   └── README.md
	│   │   ├── sub-project-2
	│   │   ├── sub-project-3
	│   │   └── README.md
	│   ├── yy-project
	│   └── public_sys_resources            # 公共资源文件，如通用的系统图片，如警告、提示等                        
	├── CONTRIBUTING.md 
	├── LICENSE 
	├── LICENSE-CC-BY-4.0 
	├── OWNERS 
	└── README.md

```

## Fork-Pull开发模式

- Fork仓库

在提交昇腾代码之前，请确保昇腾已经被fork到你自己的仓库当中，这可以使得昇腾仓库和你的仓库并行开发，因此请确保两者之间的一致性。

- Clone远程仓库

如果你想下载代码到你的本地机器，请使用git。

```shell
    git clone https://gitee.com/{insert_your_forked_repo}/docs-openmind.git
    git remote add upstream https://gitee.com/ascend/docs-openmind.git
    ```

- 本地代码开发

为了保证并行分支之间的一致性，在开发代码前请创建一个新的分支：

```shell
    git checkout -b {new_branch_name} origin/master
    ```

说明：origin 为昇思官方仓库，注意在创建自己仓库时尽量避免出现origin关键字，以免出现混淆

- 推送代码到远程仓库

在更新代码之后，你需要按照如下方式来推送代码到远程仓库：

```shell
    git add .
    git status # Check the update status
    git commit -m "Your commit title"
    git commit -s --amend #Add the concrete description of your commit
    git push origin {new_branch_name}
    ```

- 对昇腾仓库提交推送请求--提交PR

在最后一步，你需要在你的新分支和昇腾`master`分支提交一个比较请求。在这之后，Jenkins门禁会自动运行创建测试，之后你的代码会被合入到远程主仓分支上。

## 报告问题

当你遇到一个问题时,提交一个详细的问题单会对昇腾有很大的贡献，我们永远欢迎填写详细、全面的issue。

当报告issue时，参考下面的格式：

- 你使用的环境(mindspore、os、python等)是什么版本的
- 这是一个BUG REPORT还是一个FEATURE REQUEST
- 这个问题的类型是什么，在issue dashbord上添加标签并进行高亮
- 发生了什么问题
- 你期望的结果是什么
- 如何复现
- 对审核人员必要的注释

李鹏达/docs-openmind

简介

发行版

贡献者

近期动态

李鹏达/docs-openmind .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

李鹏达/docs-openmind