feat: add GitHub files in .github directory
#6
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @Paulchen5, 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 establishing foundational development and collaboration standards for the repository. It introduces a set of configuration files for consistent code formatting, streamlines GitHub workflows with issue templates and code ownership, and provides recommended VS Code settings for an optimized development environment. The files were adapted from the a2a-python project to align with this repository's needs.
Highlights
- Standardized Development Environment: This PR introduces
.editorconfigand.vscode/configurations to ensure consistent code formatting, style, and recommended extensions for developers using VS Code, promoting a unified development experience. - Streamlined GitHub Workflows: New GitHub configuration files are added, including
CODEOWNERSfor automated review assignments,ISSUE_TEMPLATEs for structured bug reports and feature requests, andconventional-commit-lint.yamlfor enforcing consistent commit message standards. - Project Setup and Maintainability: The changes lay foundational configuration files essential for project setup, facilitating better collaboration, code quality, and long-term maintainability by adopting established practices from a related project.
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 is currently in preview and 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 to provide feedback.
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. ↩
There was a problem hiding this comment.
Code Review
This pull request adds a number of project configuration files for editor settings, issue templates, and commit linting. I've provided some feedback to improve the configurations, such as using correct keys in the issue templates, updating deprecated settings for golangci-lint, and ensuring consistency in the recommended VS Code extensions and settings. Addressing these points will improve the developer experience and long-term maintainability of the project.
.vscode/settings.json
Outdated
| ], | ||
| "go.formatTool": "custom", | ||
| "go.alternateTools": { | ||
| "customFormatter": "golangci-lint" | ||
| }, | ||
| "go.formatFlags": [ | ||
| "fmt", | ||
| "--stdin" | ||
| ] |
There was a problem hiding this comment.
The configuration to use golangci-lint as a custom formatter uses the fmt command. This command is deprecated in golangci-lint and will be removed in a future version.
]
| name: 🐞 Bug Report | ||
| description: File a bug report | ||
| title: "[Bug]: " | ||
| type: Bug |
There was a problem hiding this comment.
The type key is not a valid top-level key in GitHub Issue form schemas. To automatically add a label to issues created from this template, you should use the labels key. A common label for bug reports is bug.
labels: ["bug"]
| description: Also tell us what you expected to happen and how to reproduce the | ||
| issue. | ||
| placeholder: Tell us what you see! | ||
| value: A bug happened! |
There was a problem hiding this comment.
The value attribute pre-fills the text area with "A bug happened!". It's generally better to leave value empty and use placeholder to guide the user, which you are already doing.
| name: 💡 Feature Request | ||
| description: Suggest an idea for this repository | ||
| title: "[Feat]: " | ||
| type: Feature |
There was a problem hiding this comment.
The type key is not a valid top-level key in GitHub Issue form schemas. To automatically add a label to issues created from this template, you should use the labels key. A common label for feature requests is enhancement.
labels: ["enhancement"]
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/a2aproject/a2a-go?tab=coc-ov-file#readme) |
There was a problem hiding this comment.
The link to the Code of Conduct points to the repository's main page rather than a specific Code of Conduct document. This can be confusing for users. It's standard practice to have a CODE_OF_CONDUCT.md file in the repository root or in the .github directory and link directly to it.
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/a2aproject/a2a-go/blob/main/CODE_OF_CONDUCT.md)
.vscode/extensions.json
Outdated
| "recommendations": [ | ||
| "golang.go", | ||
| "EditorConfig.EditorConfig", | ||
| "esbenp.prettier-vscode" |
There was a problem hiding this comment.
You are recommending esbenp.prettier-vscode, but there is no configuration in .vscode/settings.json to use it as a default formatter for any file type. This can lead to an inconsistent state where developers have the extension but it's not being used, or they might configure it differently.
.vscode/settings.json
Outdated
| "go.lintTool": "golangci-lint", | ||
| "go.lintFlags": [ | ||
| "--path-mode=abs", | ||
| "--fast-only" |
There was a problem hiding this comment.
The golangci-lint flag --fast-only is deprecated. You should use --fast instead.
"--fast"
Paulchen5
force-pushed
the
add-dot-github-files
branch
from
54ffd04 to
4e51fbc
Compare
Paulchen5
changed the title
.github directory
copied the files from the https://github.com/a2aproject/a2a-python project with slightly adjustments.