Skip to content

contributing.md

Latest commit

 

History

History
89 lines (64 loc) · 2.85 KB

contributing.md

File metadata and controls

89 lines (64 loc) · 2.85 KB

How to Contribute

We would love to accept your patches and contributions to this project.

Before you begin

Sign our Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.

If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don't need to do it again.

Visit https://cla.developers.google.com/ to see your current agreements or to sign a new one.

Review our Community Guidelines

This project follows Google's Open Source Community Guidelines.

Contribution process

Setup

  1. It is recommended to do development in a separate virtual environment

    python3.12 -m venv <your-env>

  2. Install all the build, dev, test and docs dependencies

    pip install ".[dev, test, docs]"

  3. Configure your IDE to the same venv interpreter

Code Reviews

  1. From the project root dir, run the linter and make sure all the tests pass before raising the PR 
    pyink .
pylint google/cloud/dataproc_ml
pylint --disable=protected-access,missing-function-docstring,missing-module-docstring,missing-class-docstring tests/
pytest .
  2. Add the output of the test run in the PR description

Documentation

Keep documentation up to date with your changes and only expose Public APIs.

To view the public docs, run

sphinx-build -b html docs/ docs/_build/html
open docs/_build/html/index.html

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Source Code Headers

Every file containing source code must include copyright and license information. This includes any JS/CSS files that you might be serving out to browsers. (This is to help well-intentioned people avoid accidental copying that doesn't comply with the license.)

Apache header:

Copyright 2025 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.