HyukjinKwon commented on a change in pull request #32926: URL: https://github.com/apache/spark/pull/32926#discussion_r652403517
########## File path: python/docs/source/development/ps_contributing.rst ########## @@ -1,192 +0,0 @@ -================== -Contributing Guide -================== - -.. contents:: Table of contents: - :depth: 1 - :local: - -Types of Contributions -====================== - -The largest amount of work consists simply of implementing the pandas API using Spark's built-in functions, which is usually straightforward. But there are many different forms of contributions in addition to writing code: - -1. Use the project and provide feedback, by creating new tickets or commenting on existing relevant tickets. - -2. Review existing pull requests. - -3. Improve the project's documentation. - -4. Write blog posts or tutorial articles evangelizing pandas API on Spark and help new users learn pandas API on Spark. - -5. Give a talk about pandas API on Spark at your local meetup or a conference. - - -Step-by-step Guide For Code Contributions -========================================= - -1. Read and understand the `Design Principles <design.rst>`_ for the project. Contributions should follow these principles. - -2. Signaling your work: If you are working on something, comment on the relevant ticket that you are doing so to avoid multiple people taking on the same work at the same time. It is also a good practice to signal that your work has stalled or you have moved on and want somebody else to take over. - -3. Understand what the functionality is in pandas or in Spark. - -4. Implement the functionality, with test cases providing close to 100% statement coverage. Document the functionality. - -5. Run existing and new test cases to make sure they still pass. Also run `dev/reformat` script to reformat Python files by using `Black <https://github.com/psf/black>`_, and run the linter `dev/lint-python`. - -6. Build the docs (`make html` in `docs` directory) and verify the docs related to your change look OK. - -7. Submit a pull request, and be responsive to code review feedback from other community members. - -That's it. Your contribution, once merged, will be available in the next release. - - -Environment Setup Review comment: This section was moved and merged after being revised and tested. -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
