This is an automated email from the ASF dual-hosted git repository.
sunithabeeram pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pinot.git
The following commit(s) were added to refs/heads/master by this push:
new bf161ec readthedocs: Update instructions for using fork (#3937)
bf161ec is described below
commit bf161ecb0ec59c1f967bf47e45b8ed9c6316264d
Author: Sunitha Beeram <[email protected]>
AuthorDate: Mon Mar 11 13:45:52 2019 -0700
readthedocs: Update instructions for using fork (#3937)
* Update instructions for using fork
* More info on fork
* Update guidelines for working with forks
* Address review comments
---
docs/contribution_guidelines.rst | 22 +++++++++++++++-------
docs/dev_env.rst | 13 +++++++++----
2 files changed, 24 insertions(+), 11 deletions(-)
diff --git a/docs/contribution_guidelines.rst b/docs/contribution_guidelines.rst
index b1620c1..d2e7a81 100644
--- a/docs/contribution_guidelines.rst
+++ b/docs/contribution_guidelines.rst
@@ -20,7 +20,7 @@
Contribution Guidelines
=======================
-Before you begin to contribute, make sure you have reviewed :ref:`dev-setup`
and :ref:`code-modules` sections.
+Before you begin to contribute, make sure you have reviewed :ref:`dev-setup`
and :ref:`code-modules` sections and that you have created your own fork of the
pinot source code.
Create an issue for the change
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -35,7 +35,15 @@ Create a branch for your change
.. code-block:: none
- $ cd incubator-pinot
+ $ cd pinot
+ #
+ # ensure you are starting from the latest code base
+ # the following steps, ensure your fork's (origin's) master is up-to-date
+ #
+ $ git fetch upstream
+ $ git checkout master
+ $ git merge upstream/master
+ # create a branch for your issue
$ git checkout -b <your issue branch>
Make the necessary changes. If the changes you plan to make are too big, make
sure you break it down into smaller tasks.
@@ -117,7 +125,7 @@ Identify a list of tests for the changes you have made.
Depending on the scope o
License Headers for newly added files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-All source code files should have license headers. To automatically add the
header for any new file you plan to checkin, run in ``incubator-pinot``
top-level folder:
+All source code files should have license headers. To automatically add the
header for any new file you plan to checkin, run in ``pinot`` top-level folder:
.. code-block:: none
@@ -136,9 +144,9 @@ If you checkin third-party code or files, please make sure
you review Apache gui
Once you determine the code you are pulling in adhere to the guidelines above,
go ahead pull the changes in.
Do not add license headers for them. Follow these instructions to ensure we
are compliant with Apache Licensing process:
-* Under ``incubator-pinot/licenses`` add a LICENSE-<newlib> file that has the
license terms of the included library.
-* Update the ``incubator-pinot/LICENSE`` file to indicate the newly added
library file paths under the corresponding supported Licenses.
-* Update the exclusion rules for ``license`` and ``rat`` maven plugins in the
parent pom: ``incubator-pinot/pom.xml``.
+* Under ``pinot/licenses`` add a LICENSE-<newlib> file that has the license
terms of the included library.
+* Update the ``pinot/LICENSE`` file to indicate the newly added library file
paths under the corresponding supported Licenses.
+* Update the exclusion rules for ``license`` and ``rat`` maven plugins in the
parent pom: ``pinot/pom.xml``.
If attention to the licensing terms in not paid early on, they will be caught
much later in the process, when we prepare to make a new release.
Updating code at that time to work with the right libraries at that time might
require bigger refactoring changes and delay the release process.
@@ -197,7 +205,7 @@ It is possible that while your change is being reviewed,
other changes were made
$ git commit -m "Meaningful message for the udpate"
# pull new changes
$ git checkout master
- $ git pull
+ $ git merge upstream/master
$ git checkout <your issue branch>
$ git rebase master
diff --git a/docs/dev_env.rst b/docs/dev_env.rst
index dd8aee6..f7a7fb7 100644
--- a/docs/dev_env.rst
+++ b/docs/dev_env.rst
@@ -37,16 +37,21 @@ Getting the Source Code
Create a fork
^^^^^^^^^^^^^
To limit the number of branches created on the Apache Pinot repository, we
recommend that you create a fork by clicking on the fork button `here
<https://github.com/apache/incubator-pinot>`_.
+Read more about `fork workflow here
<https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow>`_
Clone the repository locally
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: none
- $mkdir workspace
- $cd workspace
- $git clone https://github.com/<username>/incubator-pinot.git
- $cd incubator-pinot
+ $ mkdir workspace
+ $ cd workspace
+ $ git clone [email protected]:<github username>/pinot.git
+ $ cd pinot
+ # set upstream
+ $ git remote add upstream https://github.com/apache/incubator-pinot
+ # check that the upstream shows up correctly
+ $ git remote -v
Maven
-----
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
