[incubator-pinot] branch master updated: Update dev guide to include toc for high level sections (#3973)

[su...@apache.org]

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 2411d89  Update dev guide to include toc for high level sections (#3973)
2411d89 is described below

commit 2411d89cc699749fa6edadce3850ccfb0f758581
Author: Sunitha Beeram <sb...@linkedin.com>
AuthorDate: Thu Mar 14 11:49:12 2019 -0700

    Update dev guide to include toc for high level sections (#3973)
---
 docs/code_modules.rst            |  6 +++++-
 docs/contribution_guidelines.rst | 19 ++++++++++++++-----
 2 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/docs/code_modules.rst b/docs/code_modules.rst
index 6a01abf..33e5a20 100644
--- a/docs/code_modules.rst
+++ b/docs/code_modules.rst
@@ -19,8 +19,12 @@
 
 .. _code-modules:
 
+
+*****************************
 Code Modules and Organization
-=============================
+*****************************
+
+.. contents:: Table of Contents
 
 Before proceeding to contributing changes to Pinot, review the contents of this section.
 
diff --git a/docs/contribution_guidelines.rst b/docs/contribution_guidelines.rst
index d2e7a81..e980158 100644
--- a/docs/contribution_guidelines.rst
+++ b/docs/contribution_guidelines.rst
@@ -17,21 +17,24 @@
 .. under the License.
 ..
 
+***********************
 Contribution Guidelines
-=======================
+***********************
+
+.. contents:: Table of Contents
 
 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
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------------------
 Create a Pinot issue for the change you would like to make. Provide information on why the change is needed and how you
 plan to address it. Use the conversations on the issue as a way to validate assumptions and the right way to proceed.
-Be sure to review sections on :ref:`compatiblity-changes` and :ref:`external-libs`.
+Be sure to review sections on :ref:`compatibility-changes` and :ref:`external-libs`.
 
 Once you are clear about what you want to do, proceed with the next steps listed below.
 
 Create a branch for your change
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------------
 
 .. code-block:: none
 
@@ -48,6 +51,11 @@ Create a branch for your change
 
 Make the necessary changes. If the changes you plan to make are too big, make sure you break it down into smaller tasks.
 
+Making the changes
+------------------
+
+Follow the recommendations/best-practices noted here when you are making changes.
+
 Code documentation
 ^^^^^^^^^^^^^^^^^^
 Please ensure your code is adequately documented. Some things to consider for documentation:
@@ -152,7 +160,7 @@ If attention to the licensing terms in not paid early on, they will be caught mu
 Updating code at that time to work with the right libraries at that time might require bigger refactoring changes and delay the release process.
 
 Creating a PR
-^^^^^^^^^^^^^
+-------------
 
 * Verifying code-style
 
@@ -214,6 +222,7 @@ At this time, if rebase flags any conflicts, resolve the conflicts and follow th
 Run additional tests/validations for the new changes and update the PR by pushing your changes:
 
 .. code-block:: none
+
   $ git push origin <your issue branch>
 
 * Once your change is merged, check to see if any documentation needs to be updated. If so, create a PR for documentation.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org