Skip to content

Latest commit

 

History

History
19 lines (10 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

19 lines (10 loc) · 1.35 KB
Raw

English SDK for Apache Spark - Contribution Guide

Welcome to the English SDK for Apache Spark contribution guide. We're glad you're considering contributing to our project. The project is currently in the early stages, so your contributions, whether big or small, are highly valuable.

Contribution Process

  1. Make Your Changes: Implement your changes in a new branch in your fork of the project.

  2. Test and Verify Your Changes: Make sure your changes work as expected and don't interfere with existing features. This should include running existing tests, verifying with the example Jupyter notebook examples/example.ipynb, and potentially adding new tests or notebooks. Please note that we are currently developing a more robust testing suite and Github Actions for PR testing.

  3. Update Documentation: If your changes affect how the English SDK for Apache Spark is used or its output, update the README.md file accordingly.

  4. Submit a Pull Request: Once your changes are ready and all tests pass, submit a Pull Request (PR) with a clear title and detailed description of your changes.

Need Assistance?

If you have any questions or run into issues, feel free to open a new issue in the GitHub repository. We're here to help!

Thank you for considering contributing to the English SDK for Apache Spark. We look forward to your contributions.