Fix broken STYLE_GUIDE.md references#859
Conversation
STYLE_GUIDE.md does not exist and never has in this repo. All three references to it were broken links: - CONTRIBUTING.md: Replace broken link with inline references to Google Python Style and Google TypeScript Style guides - .github/PULL_REQUEST_TEMPLATE.md: Point Style Guide link to CONTRIBUTING.md#coding-style - .gemini/styleguide.md: Point style section link to CONTRIBUTING.md#coding-style Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request correctly fixes broken links to a STYLE_GUIDE.md file. The changes are clear and improve the contributor documentation by pointing to the correct style guide information. I have one suggestion to further improve the documentation clarity in CONTRIBUTING.md.
| Please follow these guidelines: | ||
| * **Python**: specific formatting, linting, and naming conventions ([Google Python Style](https://google.github.io/styleguide/pyguide.html)). | ||
| * **TypeScript**: usage of `gts`, naming conventions, and code organization ([Google TypeScript Style](https://google.github.io/gts/)). |
There was a problem hiding this comment.
While it's great that you've added direct links for the Python and TypeScript style guides, the 'License Headers' item on line 58 is now left without a source of truth, as the STYLE_GUIDE.md it previously referenced is being removed. To make the contribution guidelines more complete, please consider adding a link or more details about the required copyright notices for license headers.
There was a problem hiding this comment.
but the STYLE_GUIDE.md link is not there, https://github.com/google/A2UI/blob/main/STYLE_GUIDE.md, that's a 404 - page not found
1 participant
Summary
STYLE_GUIDE.mdis referenced in 3 files but does not exist (and has no git history), making all 3 links broken:CONTRIBUTING.md: Replaced the broken[STYLE_GUIDE.md](STYLE_GUIDE.md)link with inline references to Google Python Style Guide and Google TypeScript Style (gts).github/PULL_REQUEST_TEMPLATE.md: Updated[Style Guide]link reference from../STYLE_GUIDE.md→../CONTRIBUTING.md#coding-style.gemini/styleguide.md: Updated broken link from../STYLE_GUIDE.md→../CONTRIBUTING.md#coding-styleTest plan
STYLE_GUIDE.mdin the repo