mcvsubbu commented on a change in pull request #3937: readthedocs: Update instructions for using fork URL: https://github.com/apache/incubator-pinot/pull/3937#discussion_r264342953
########## File path: 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 Review comment: Can we move the section on how to create a fork into the contribution guidelines? We seem to say here that creating a branch is not recommended, yet that is what we write about in contribution guidelines. Maybe we should remove the text on creating branches, and just retain one on creating forks? Not sure what the limitations are in terms of branches created. Does Apache have a limit? Or, are we worried that people may not delete the branch after commit? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
