Skip to content

[DOC] Unify GitHub naming#18794

Open
ruslo wants to merge 1 commit intoapache:mainfrom
ruslo:pr.doc_github
Open

[DOC] Unify GitHub naming#18794
ruslo wants to merge 1 commit intoapache:mainfrom
ruslo:pr.doc_github

Conversation

@ruslo
Copy link
Contributor

@ruslo ruslo commented Feb 18, 2026

Fix GitHub naming in documentation and comments

  • Github -> GitHub
  • github -> GitHub

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @ruslo, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the consistency and professionalism of the project's documentation and internal comments by standardizing the capitalization of 'GitHub'. The changes ensure that all references to the platform adhere to its official casing, enhancing readability and accuracy throughout the repository.

Highlights

  • Documentation and Comments Update: Standardized the capitalization of 'GitHub' across various documentation files, comments, and configuration files to ensure consistency.
  • Codebase Consistency: Corrected instances of 'Github' and 'github' to 'GitHub' in file comments, docstrings, and string literals within the codebase.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • .github/CODEOWNERSHIP
    • Updated comment to use 'GitHub' capitalization.
  • CMakeLists.txt
    • Corrected 'github' to 'GitHub' in a comment and a configuration option description.
  • ci/scripts/github/init.py
    • Updated docstring to use 'GitHub' capitalization.
  • cmake/config.cmake
    • Corrected 'github' to 'GitHub' in a comment.
  • docs/conf.py
    • Updated 'Github' to 'GitHub' in a header dropdown link configuration.
  • docs/contribute/document.rst
    • Corrected 'Github Pull Requests' to 'GitHub Pull Requests'.
  • docs/contribute/pull_request.rst
    • Updated 'Github (GH) platform' to 'GitHub (GH) platform'.
    • Corrected 'Github usernames' to 'GitHub usernames' in two separate guidelines.
  • docs/contribute/release_process.rst
    • Changed 'Github issue' to 'GitHub issue'.
    • Updated 'Github and upload the artifacts' to 'GitHub and upload the artifacts'.
    • Corrected 'TAG on Github' to 'TAG on GitHub'.
  • docs/install/docker.rst
    • Updated 'clone the github repo' to 'clone the GitHub repo'.
  • docs/install/from_source.rst
    • Corrected 'Get Source from Github' to 'Get Source from GitHub' in a heading and descriptive text.
  • tests/python/arith/test_arith_solve_linear_equations.py
    • Updated 'report it in github issue' to 'report it in GitHub issue' in a test message.
  • tests/python/arith/test_arith_solve_linear_inequality.py
    • Updated 'report it in github issue' to 'report it in GitHub issue' in a test message.
  • tests/python/tir-base/test_tir_imm_values.py
    • Updated 'report it in github issue' to 'report it in GitHub issue' in a test message.
  • tests/scripts/release/README.md
    • Corrected 'Export release report on Github' to 'Export release report on GitHub'.
    • Updated 'apache.org or github release page' to 'apache.org or GitHub release page'.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request does a good job of unifying the naming of GitHub across various documentation files and comments, which improves consistency. I've found a few places with a minor pre-existing typo that could be fixed as part of this change. My suggestions are in the comments below. Otherwise, the changes look good.

Fix GitHub naming in documentation and comments

- Github -> GitHub
- github -> GitHub

(Additionally fix 'spirv-tools.and' typo as review bot requested)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant