Add configuration for GCA and draft coding style. #481
+177
−35
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This configures Google Code Assist so that it can be more helpful in its reviews. I also limited its comments to six at a time so as not to overwhelm.
I added a draft
STYLE_GUIDE.mdthat includes what I think basic coding style should be for python and typescript projects. This is so that GCA has something concrete to gauge against, and we can totally modify it in future: it's just a draft. It follows Google style for OSS projects.I also updated the
GEMINI.mdto describe the current state of the repo.Summary
This pull request enhances the project's development workflow and code quality by integrating automated review assistance and establishing clear, comprehensive coding standards. It introduces Google Code Assist for more effective feedback, provides a detailed
CODING_STYLE.mdfor Python and TypeScript based on Google's guidelines, and updates the contribution process with a new PR template and a reference to the style guide.Highlights
STYLE_GUIDE.mddocument outlining basic coding style guidelines for Python and TypeScript projects, adhering to Google's open-source style. This serves as a reference for GCA and future contributions.PULL_REQUEST_TEMPLATE.mdto streamline the pull request creation process, including sections for description, issue linking, and a pre-launch checklist.CONTRIBUTING.mdto include a new section that references the newly addedCODING_STYLE.md, guiding contributors to adhere to the established style standards.GEMINI.mdto accurately describe the current state of the repository, reflecting the changes and additions made.