## MindSpore / docsApache-2.0 .gitee-modal { width: 500px !important; }

Explore and code with more than 5 million developers，Free private repositories ！：）
• Python 69.0%
• Jupyter Notebook 28.9%
• Makefile 1.1%
• Shell 1.0%
CONTRIBUTING_DOC.md 2.46 KB
chengxiao authored 2020-05-18 16:23 . Correct inaccurate descriptions

# Contributing Documents

You are welcome to contribute MindSpore documents. Documents that meet requirements will be displayed on the MindSpore official website.

## Creating or Updating Documents

This project supports contribution documents in MarkDown and reStructuredText formats. You can create the .md or .rst files or modify existing documents.

## Submitting Modification

The procedure for submitting the modification is the same as that for submitting the code. For details, see Code Contribution Guide.

## Document Writing Specifications

• The title supports only the ATX style. The title and context must be separated by a blank line.

# Heading 1

### Heading 3
• If the list title and content need to be displayed in different lines, add a blank line between the title and content. Otherwise, the line breaks may not be implemented.

- Title

Content
• Anchors (hyperlinks) in the table of content can contain only Chinese characters, lowercase letters, and hyphens (-). Spaces or other special characters are not allowed. Otherwise, the link is invalid.

• Precautions are marked with a right angle bracket (>).

> Precautions
• References should be listed at the end of the document and marked in the document.

Add a [number] after the referenced text or image description.

## References

[1] Author. [Document Name](http://xxx).

[2] Author. Document Name.
• Comments in the sample code must comply with the following requirements:

• Comments are written in English.
• Use """ to comment out Python functions, methods, and classes.
• Use # to comment out other Python code.
• Use // to comment out C++ code.
"""
Comments on Python functions, methods, and classes
"""


• A blank line must be added before and after an image and an image title. Otherwise, the typesetting will be abnormal.

Example:

![](./xxx.png)

Figure 1: xxx

The following content.
1
https://gitee.com/mindspore/docs.git
git@gitee.com:mindspore/docs.git
mindspore
docs
docs
master