Skip to content

Conversation

@ognis1205
Copy link
Contributor

Description

Add GitHub Issue and Pull Request templates for the DeepFabric project.

  • Bug Report template (bug_report.yml)
  • Feature Request template (feature_request.yml)
  • Pull Request template (PULL_REQUEST_TEMPLATE.md)

These templates include structured fields, checklists, and guidance to help contributors provide clear and consistent information.


Motivation and Context

Providing templates helps standardize contribution workflows, reduces back-and-forth in PR/Issue discussions, and ensures that required information (like reproduction steps, environment info, or test coverage) is provided upfront.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @ognis1205, 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 significantly enhances the contribution process for the DeepFabric project by introducing structured GitHub issue and pull request templates. These new templates aim to standardize the information collected from contributors, ensuring that bug reports are detailed, feature requests are well-defined, and pull requests adhere to project guidelines, ultimately reducing communication overhead and improving overall project maintainability.

Highlights

  • Bug Report Template Added: A new bug_report.yml template has been introduced to streamline the submission of bug reports. It includes structured fields for bug description, steps to reproduce, expected behavior, screenshots/logs, and software environment information, ensuring comprehensive details are provided upfront.
  • Feature Request Template Added: A feature_request.yml template has been added to guide contributors in proposing new features. This template prompts for a clear feature description, desired solution, and alternatives considered, fostering well-defined enhancement suggestions.
  • Pull Request Template Added: A comprehensive PULL_REQUEST_TEMPLATE.md has been created to standardize pull request submissions. It includes sections for description, motivation, testing details, types of changes, and a detailed checklist covering code style, documentation, formatting, linting, and testing.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces valuable GitHub issue and pull request templates, which will greatly help in standardizing contributions to the project. The templates are well-structured and cover the essential information needed for bug reports, feature requests, and pull requests. I have a few minor suggestions to enhance the clarity and usability of the templates, primarily in the PULL_REQUEST_TEMPLATE.md and feature_request.yml files. Overall, these are excellent additions.

@ognis1205
Copy link
Contributor Author

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces standardized templates for bug reports, feature requests, and pull requests, which is a great step towards improving the contribution workflow. The templates are well-structured and comprehensive. I've provided a couple of suggestions to further enhance consistency and provide more guidance to contributors within the templates themselves.

@ognis1205 ognis1205 force-pushed the docs/add-github-templates branch from cae6b53 to 8fbc410 Compare January 9, 2026 02:19
@ognis1205 ognis1205 force-pushed the docs/add-github-templates branch from 8fbc410 to 2941fd9 Compare January 13, 2026 06:08
Signed-off-by: Shingo OKAWA <[email protected]>
@ognis1205 ognis1205 requested a review from lukehinds January 13, 2026 06:13
@ognis1205
Copy link
Contributor Author

Thanks for the review @lukehinds ! I've applied your suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants