How to Contribute

Your contributions and patches to GKE AI Labs are highly valued and appreciated! To ensure the continued success of our GKE AI Labs repository, we kindly ask that you adhere to the following guidelines when submitting your code and documentation.

New contributors should review the raw code and documentation of existing content to gain a better understanding of the approved format and ensure all guidelines are met. If you have any questions, please reach out to the GKE AI Labs project maintainers.

Getting started

Anyone can open an issue about documentation, or contribute a change with a pull request (PR) to the ai-on-gke/website GitHub repository. You need to be comfortable with git and GitHub to work effectively in the GKE AI Labs community.

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.

Your first contribution

You can prepare for your first contribution by reviewing several steps beforehand.

1. Ensure to review the repository License.
2. Ensure to sign the Google CLA. For more information, check Contributor License Agreements.
3. Check ai-on-gke/website issues list for issues that make good entry points.
4. Open a pull request using GitHub to existing documentation and learn more about filing issues in GitHub.
5. Review pull requests from other GKE AI Labs community members for accuracy and language.
6. Read the GKE AI Labs Contribution process so you can leave informed comments.
7. Learn about page content types and Hugo shortcodes.

Contribution process

Issues & Pull Requests

To ensure clear communication and transparency within our open-source community, we kindly ask contributors to initiate a discussion by opening an issue or pull request (PR) before starting work on their proposed changes. This practice allows for community input and consensus-building, ensuring that all contributions align with the project’s goals and ongoing work.

Content guidelines

To maintain consistency and project integrity, we strongly recommend that you leverage existing documentation and code when contributing to our collaborative open-source environment. These resources represent a wealth of collective knowledge, incorporating best practices, coding standards, and project-specific conventions. Familiarize yourself with our existing documentation, including preferred writing style, formatting, and content structure, before creating new documentation. Use the following rules when writing documentation:

1. Markdownlint Rule for Headings: Use hash symbols (#) to indicate heading levels in Markdown. Ensure that these headings follow a proper hierarchy.
2. Use of Lists: Ensure consistent indentation and bullet style formatting for lists.
3. Images: Image links should be formatted with the alt text in square brackets followed by the image URL in parentheses.
4. Code Blocks: Ensure to specity the correct programming language (e.g Bash, Python, Go) and indent the code block correctly.
5. Links: Ensure all links include the square brackets for the display text and the parentheses for the URL. Repair any broken links by entering the correct URL.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose.