Skip to content
This repository was archived by the owner on Nov 17, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ Contents
* [Documentation and Tutorials](http://mxnet.readthedocs.org/en/latest/)
* [Open Source Design Notes](http://mxnet.readthedocs.org/en/latest/#open-source-design-notes)
* [Code Examples](example)
* [Build Instruction](doc/build.md)
* [Installation](doc/build.md)
* [Features](#features)
* [Contribute to MXNet](doc/contribute.md)
* [License](#license)

Features
Expand All @@ -45,12 +46,6 @@ Bug Reporting
-------------
* For reporting bugs please use the [mxnet/issues](https://github.com/dmlc/mxnet/issues) page.

Contributing to MXNet
---------------------
MXNet has been developed and used by a group of active community members.
Everyone is more than welcome to contribute. It is a way to make the project better and more accessible to more users.
* Please add your name to [CONTRIBUTORS.md](CONTRIBUTORS.md) after your patch has been merged.

License
-------
© Contributors, 2015. Licensed under an [Apache-2.0](https://github.com/dmlc/mxnet/blob/master/LICENSE) license.
Expand Down
11 changes: 7 additions & 4 deletions doc/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ Guidelines
----------
* [Submit Pull Request](#submit-pull-request)
* [Git Workflow Howtos](#git-workflow-howtos)
- [How to resolve conflict with master](#how-to-resolve-conflict-with-master)
- [How to combine multiple commits into one](#how-to-combine-multiple-commits-into-one)
- [What is the consequence of force push](#what-is-the-consequence-of-force-push)
* [Document](#document)
* [Testcases](#testcases)
* [Examples](#cexamples)
* [Core Library](#core-library)
* [Python Package](#r-package)
* [Python Package](#python-package)
* [R Package](#r-package)

Submit Pull Request
Expand Down Expand Up @@ -54,8 +57,8 @@ git rebase --continue
git push --force
```

### How to merge multiple commits
Sometimes we want to merge multiple commits, especially when later commits are only fixes to previous ones,
### How to combine multiple commits into one
Sometimes we want to combine multiple commits, especially when later commits are only fixes to previous ones,
to create a PR with set of meaningful commits. You can do it by following steps.
- Before doing so, configure the default editor of git if you haven't done so before.
```bash
Expand All @@ -72,7 +75,7 @@ git rebase -i HEAD~3
git push --force
```

### What is the consequence of force push.
### What is the consequence of force push
The previous two tips requires force push, this is because we altered the path of the commits.
It is fine to force push to your own fork, as long as the commits changed are only yours.

Expand Down