-
Notifications
You must be signed in to change notification settings - Fork 4.5k
adds EditorConfig to configure a consistent indent style and size for each file extension #35956
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @nyoungstudios, 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 aims to improve code consistency and ease onboarding for new contributors by adding an .editorconfig file. This configuration standardizes indentation styles and sizes across various programming languages and file types within the project. The primary goal is to ensure that all code adheres to a unified formatting standard, reducing friction for developers using different editors and preventing style-related merge conflicts.
Highlights
- Introduction of .editorconfig: This pull request introduces a new
.editorconfigfile at the root of the repository. This file helps maintain consistent coding styles, particularly indentation, across different editors and IDEs used by contributors. - Standardized 2-Space Indentation: The default indentation for most file types, including Python, shell scripts, Java, HTML, XML, CSS, JavaScript, TypeScript, JSON, and Markdown, has been standardized to 2 spaces. This addresses existing inconsistencies and aligns with the project's preferred style, especially for Python files where 2 spaces are used instead of the common 4.
- Specific Indentation Rules for Go and Dockerfiles: Specific indentation rules have been set for certain file types: Go-related files (
.go,.mod,.sum) will now use tabs for indentation, andDockerfiles will use 4 spaces.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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
-
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. ↩
|
Assigning reviewers: R: @damccorm added as fallback since no labels match configuration Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
damccorm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, LGTM!
Please add a meaningful description for your change here
Follow up to this pr: #35564
Adds
.editorconfigfile so that new contributors do not need to change their editor indent settings to start contributing to this project. Mainly, since this project uses 2 spaces for Python files and the default in most editors and other Python projects is 4 spaces.Defaults to 2 spaces for all file extensions since that is what I found after looking at these various extensions:
.py.sh.java/.gradle.sql.html.xml.css.md.js.ts.json.yml/.yamlThere were some inconsistencies in some of the above file extensions including
.sh,.html,.xml,.css,.js, and.json.Defaults
.gofile extensions to use tabs and whatever the editor default is. No need to set the default number of spaces here since a tab can be viewed however the user likes.Defaults
Dockerfileto use 4 spaces.Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.