From 4faab08fc853e6cc3cd0e6d7261812dbdb59eac0 Mon Sep 17 00:00:00 2001 From: tqchen Date: Fri, 16 Oct 2015 12:31:39 -0700 Subject: [PATCH] [DOC] contribute guideline --- README.md | 9 ++------- doc/contribute.md | 11 +++++++---- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0cff33bccbec..29949c3ea2b8 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. diff --git a/doc/contribute.md b/doc/contribute.md index a14d70710dcb..80e276c9d689 100644 --- a/doc/contribute.md +++ b/doc/contribute.md @@ -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 @@ -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 @@ -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.