Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gemini/styleguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This style guide outlines the coding conventions for contributions to this repos

Code should follow the relevant style guides, and use the correct
auto-formatter, for each language, as described in
[the repository contributing guide's Style section](../STYLE_GUIDE.md).
[the repository contributing guide's Style section](../CONTRIBUTING.md#coding-style).

## Best Practices

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ If you need help, consider asking for advice on the [discussion board].
[CLA]: https://cla.developers.google.com/
[Contributors Guide]: ../CONTRIBUTING.md
[discussion board]: https://github.com/google/A2UI/discussions
[Style Guide]: ../STYLE_GUIDE.md
[Style Guide]: ../CONTRIBUTING.md#coding-style
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ Here are some additional things to keep in mind during the process:

To keep our codebase consistent and maintainable, we follow specific coding standards for Python and TypeScript.

Please refer to [STYLE_GUIDE.md](STYLE_GUIDE.md) for detailed guidelines on:
* **Python**: specific formatting, linting, and naming conventions (Google Python Style).
* **TypeScript**: usage of `gts`, naming conventions, and code organization (Google TypeScript Style).
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/)).
Comment on lines +55 to +57
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

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.

Copy link
Author

Choose a reason for hiding this comment

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

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

* **License Headers**: required copyright notices.

We expect all contributors to adhere to these styles.
Expand Down