Chamikara Jayalath created BEAM-2340:
----------------------------------------

             Summary: Update contributors guide to include proper development 
instructions for python SDK
                 Key: BEAM-2340
                 URL: https://issues.apache.org/jira/browse/BEAM-2340
             Project: Beam
          Issue Type: Improvement
          Components: website
            Reporter: Chamikara Jayalath


Currently Apache Beam contributor's guide [1] gives proper developer 
instructions for Java SDK developers including Maven and IDE setup.

Contributor's guide does not mention development guidelines for Python SDK 
(other than instructions for cloning the repo using git).

I suspect people who read this guide ends up assuming that Maven is needed to 
develop Python SDK which is not the case (and AFAIK non of the Python SDK 
developers regularly use Maven).

Hence, I believe that contributor's guide should be updated to include 
following instructions.
(1) Setting up a virtual environment (for a cloned repo)
(2) Testing Python SDK
(3) IDE setup (PyCharm ?)

[1] 
https://beam.apache.org/contribute/contribution-guide/#clone-the-repository-locally



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Reply via email to