Repository: incubator-singa Updated Branches: refs/heads/master 00573e26b -> 394d78d00
SINGA-361 Add git instructions for contributors and committers Project: http://git-wip-us.apache.org/repos/asf/incubator-singa/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-singa/commit/6d43cc99 Tree: http://git-wip-us.apache.org/repos/asf/incubator-singa/tree/6d43cc99 Diff: http://git-wip-us.apache.org/repos/asf/incubator-singa/diff/6d43cc99 Branch: refs/heads/master Commit: 6d43cc99280b162d43851de33732cd82e0ecbd16 Parents: 00573e2 Author: Moaz Reyad <[email protected]> Authored: Sun May 13 05:08:45 2018 +0800 Committer: Moaz Reyad <[email protected]> Committed: Sun May 13 05:08:45 2018 +0800 ---------------------------------------------------------------------- doc/en/community/source-repository.md | 22 ------------ doc/en/community/source-repository.rst | 56 +++++++++++++++++++++++++++++ doc/en/index.rst | 5 --- 3 files changed, 56 insertions(+), 27 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/6d43cc99/doc/en/community/source-repository.md ---------------------------------------------------------------------- diff --git a/doc/en/community/source-repository.md b/doc/en/community/source-repository.md deleted file mode 100644 index 8864629..0000000 --- a/doc/en/community/source-repository.md +++ /dev/null @@ -1,22 +0,0 @@ -# Source Repository - -___ - -This project uses [Git](http://git-scm.com/) to manage its source code. Instructions on Git use can be found at [http://git-scm.com/documentation](http://git-scm.com/documentation). - -## Web Access - -The following is a link to the online source repository. - -* [https://git-wip-us.apache.org/repos/asf?p=incubator-singa.git;a=summary](https://git-wip-us.apache.org/repos/asf?p=incubator-singa.git;a=summary) - - -## Upstream for committers - -Committers need to set the upstream endpoint to the Apache git (not github) repo address, e.g., - - $ git remote add asf https://git-wip-us.apache.org/repos/asf/incubator-singa.git - -Then you (committer) can push your code in this way, - - $ git push asf <local-branch>:<remote-branch> http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/6d43cc99/doc/en/community/source-repository.rst ---------------------------------------------------------------------- diff --git a/doc/en/community/source-repository.rst b/doc/en/community/source-repository.rst new file mode 100644 index 0000000..d60f148 --- /dev/null +++ b/doc/en/community/source-repository.rst @@ -0,0 +1,56 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +Source Repository +================= + +This project uses `Git <http://git-scm.com/>`_ to manage its source code. Instructions on Git use can be found at http://git-scm.com/documentation . + +Web Access +---------- + +The following is a link to the online source repository. + +* https://git-wip-us.apache.org/repos/asf?p=incubator-singa.git;a=summary + +Contributors +------------ + +Contributors are encouraged to rebase their commits onto the latest master before sending the pull requests to make the git history clean. The following git instructors should be executed after committing the current work: + +.. code-block:: bash + + git checkout master + git pull <apache/incubator-singa upstream> master:master + git checkout <new feature branch> + git rebase master + +Committers +---------- + +To merge pull request https://github.com/apache/incubator-singa/pull/xxx, the following instructions should be executed, + +.. code-block:: bash + + git clone https://github.com/apache/incubator-singa.git + git remote add asf https://git-wip-us.apache.org/repos/asf/incubator-singa.git + # optional + git pull asf master:master + git fetch origin pull/xxx/head:prxxx + git merge prxxx + git push asf master:master + http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/6d43cc99/doc/en/index.rst ---------------------------------------------------------------------- diff --git a/doc/en/index.rst b/doc/en/index.rst index bfb68ff..0835acb 100755 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -15,11 +15,6 @@ specific language governing permissions and limitations under the License. - -.. SINGA documentation master file, created by - sphinx-quickstart on Sat Jul 9 20:36:57 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. Welcome to Apache SINGA =======================
