p60975123
/
mindspore
forked from mindspore-Ecosystem/mindspore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix issue I3CSPW

This commit is contained in:
panfei 2021-03-24 14:26:01 +08:00
parent b1c86b6a22
commit da5c43cd9d
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
CONTRIBUTING.md
View File

@ -30,23 +30,24 @@ For individual contributor, please refer to [ICLA online document](https://www.m
Please follow this style to make MindSpore easy to review, maintain and develop. Please follow this style to make MindSpore easy to review, maintain and develop.
* Coding guidelines - Coding guidelines
The *Python* coding style suggested by [Python PEP 8 Coding Style](https://pep8.org/) and *C++* coding style suggested by [Google C++ Coding Guidelines](http://google.github.io/styleguide/cppguide.html) are used in MindSpore community. The *Python* coding style suggested by [Python PEP 8 Coding Style](https://pep8.org/) and *C++* coding style suggested by [Google C++ Coding Guidelines](http://google.github.io/styleguide/cppguide.html) are used in MindSpore community.
* Unittest guidelines - Unittest guidelines
The *Python* unittest style suggested by [pytest](http://www.pytest.org/en/latest/) and *C++* unittest style suggested by [Googletest Primer](https://github.com/google/googletest/blob/master/docs/primer.md) are used in MindSpore community. The *Python* unittest style suggested by [pytest](http://www.pytest.org/en/latest/) and *C++* unittest style suggested by [Googletest Primer](https://github.com/google/googletest/blob/master/docs/primer.md) are used in MindSpore community.
### Fork-Pull development model ### Fork-Pull development model
* Fork MindSpore repository - Fork MindSpore repository
Before submitting code to MindSpore project, please make sure that this project have been forked to your own repository. It means that there will be parallel development between MindSpore repository and your own repository, so be careful to avoid the inconsistency between them. Before submitting code to MindSpore project, please make sure that this project have been forked to your own repository. It means that there will be parallel development between MindSpore repository and your own repository, so be careful to avoid the inconsistency between them.
* Clone the remote repository - Clone the remote repository
If you want to download the code to the local machine, `git` is the best way: If you want to download the code to the local machine, `git` is the best way:
```shell ```shell
# For GitHub # For GitHub
git clone https://github.com/{insert_your_forked_repo}/mindspore.git git clone https://github.com/{insert_your_forked_repo}/mindspore.git
@ -56,18 +57,20 @@ Please follow this style to make MindSpore easy to review, maintain and develop.
git remote add upstream https://gitee.com/mindspore/mindspore.git git remote add upstream https://gitee.com/mindspore/mindspore.git
``` ```
* Develop code locally - Develop code locally
To avoid inconsistency between multiple branches, checking out to a new branch is `SUGGESTED`: To avoid inconsistency between multiple branches, checking out to a new branch is `SUGGESTED`:
```shell ```shell
git checkout -b {new_branch_name} origin/master git checkout -b {new_branch_name} origin/master
``` ```
Then you can change the code arbitrarily. Then you can change the code arbitrarily.
* Push the code to the remote repository - Push the code to the remote repository
After updating the code, you should push the update in the formal way: After updating the code, you should push the update in the formal way:
```shell ```shell
git add . git add .
git status # Check the update status git status # Check the update status
@ -76,7 +79,7 @@ Please follow this style to make MindSpore easy to review, maintain and develop.
git push origin {new_branch_name} git push origin {new_branch_name}
``` ```
* Pull a request to MindSpore repository - Pull a request to MindSpore repository
In the last step, your need to pull a compare request between your new branch and MindSpore `master` branch. After finishing the pull request, the Jenkins CI will be automatically set up for building test. In the last step, your need to pull a compare request between your new branch and MindSpore `master` branch. After finishing the pull request, the Jenkins CI will be automatically set up for building test.
@ -101,11 +104,11 @@ When reporting issues, refer to this format:
### Propose PRs ### Propose PRs
* Raise your idea as an *issue* on [GitHub](https://github.com/mindspore-ai/mindspore/issues) or [Gitee](https://gitee.com/mindspore/mindspore/issues) - Raise your idea as an *issue* on [GitHub](https://github.com/mindspore-ai/mindspore/issues) or [Gitee](https://gitee.com/mindspore/mindspore/issues)
* If it is a new feature that needs lots of design details, a design proposal should also be submitted. - If it is a new feature that needs lots of design details, a design proposal should also be submitted.
* After reaching consensus in the issue discussions and design proposal reviews, complete the development on the forked repo and submit a PR. - After reaching consensus in the issue discussions and design proposal reviews, complete the development on the forked repo and submit a PR.
* None of PRs is not permitted until it receives **2+ LGTM** from approvers. Please NOTICE that approver is NOT allowed to add *LGTM* on his own PR. - None of PRs is not permitted until it receives **2+ LGTM** from approvers. Please NOTICE that approver is NOT allowed to add *LGTM* on his own PR.
* After PR is sufficiently discussed, it will get merged, abandoned or rejected depending on the outcome of the discussion. - After PR is sufficiently discussed, it will get merged, abandoned or rejected depending on the outcome of the discussion.
**PRs advisory:** **PRs advisory:**