Create Issue and Pull Request Templates by w8385 · Pull Request #302 · fedify-dev/fedify

w8385 · 2025-07-16T17:37:57Z

Summary

Create Issue and Pull Request Templates to share context consistently between contributors.

Related Issue

Create Issue and Pull Request Templates #297

Changes

Create issue templates
- You can check these image files. Issue images.zip
- Items grouped below shares same format.
  - Feature / Enhancement
  - Refactor / Performance / Test
    
    For Performance issues, the Benefits section is specifically replaced with Benchmarks.

Create PR template

You can check right this PR template

Used markdown template

## Summary
Briefly describe the main purpose and scope of this PR.

## Related Issue
Reference the related issue(s) by number.
- 

## Changes
List the specific modifications made in this PR.
Focus on *what* was changed without going into detail about impact.
- 

## Benefits
Describe the advantages or improvements brought by these changes.
Explain how these changes affect the project, users, or performance.

## Checklist
- [ ] Did you add a changelog entry to the *CHANGES.md*?
- [ ] Did you write some relevant docs about this change (if it's a new feature)?
- [ ] Did you write a regression test to reproduce the bug (if it's a bug fix)?
- [ ] Did you write some tests for this change (if it's a new feature)?
- [ ] Did you run `deno task test-all` on your machine?

## Additional Notes
Include any other information, context, or considerations.

Benefits

Supports better triage and prioritization
Labeled and structured issues can be filtered and sorted more effectively.

Encourages consistency
Contributors follow a shared structure, making issues and PRs easier to read and review.

Example Bug report

Checklist

Did you add a changelog entry to the CHANGES.md?
Did you write some relevant docs about this change (if it's a new feature)?
Did you write a regression test to reproduce the bug (if it's a bug fix)?
Did you write some tests for this change (if it's a new feature)?
Did you run deno task test-all on your machine?

Additional Notes

While the initial discussion around issues was based on Markdown formatting, I’ve converted the templates into YAML to improve their visual clarity in the GitHub UI.
If you notice any improvements that could be made—such as adjustments to the required fields—please feel free to share your thoughts!

I hope the new Issue and PR templates will be helpful for all contributors!

gemini-code-assist

Summary of Changes

Hello @w8385, I'm Gemini Code Assist¹! 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 establishes a foundational set of GitHub Issue and Pull Request templates for the repository. The primary objective is to streamline the contribution process by providing clear, structured formats for reporting issues and submitting code changes, thereby enhancing communication and maintainability.

Highlights

Standardized Issue Templates: Introduced a comprehensive set of GitHub Issue Templates in YAML format, covering various categories such as Bug Report, Chore, Documentation, Enhancement, Feature, Performance, Refactor, and Test. Each template is designed with specific fields to guide contributors in providing structured and complete information.
Standardized Pull Request Template: Added a new Markdown-based Pull Request Template to ensure consistency in PR submissions. This template includes sections for summary, related issues, changes, benefits, a checklist, and additional notes.
Improved Workflow: The new templates aim to support better issue triage and prioritization, encourage consistency in contributions, and make issues and PRs easier to read and review for all contributors.

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.

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

gemini-code-assist

Code Review

This pull request introduces issue and pull request templates to standardize contributions and improve context sharing. Suggestions have been provided to enhance their effectiveness, such as making certain fields required and improving the pull request template.

.github/ISSUE_TEMPLATE/bug-report.yml

.github/ISSUE_TEMPLATE/chore.yml

.github/ISSUE_TEMPLATE/performance.yml

.github/PULL_REQUEST_TEMPLATE.md

w8385 · 2025-07-16T18:10:35Z

/gemini review

gemini-code-assist

Code Review

This pull request introduces issue and pull request templates to improve consistency and clarity of contributions. The templates are well-structured and cover a wide range of scenarios.

.github/ISSUE_TEMPLATE/performance.yml

.github/PULL_REQUEST_TEMPLATE.md

.github/ISSUE_TEMPLATE/enhancement.yml

.github/ISSUE_TEMPLATE/chore.yml

.github/ISSUE_TEMPLATE/document.yml

.github/ISSUE_TEMPLATE/feature.yml

.github/ISSUE_TEMPLATE/performance.yml

.github/ISSUE_TEMPLATE/refactor.yml

.github/ISSUE_TEMPLATE/test.yml

dahlia · 2025-07-16T23:59:42Z

.github/PULL_REQUEST_TEMPLATE.md

+
+[//]: # (- fixes #456)


What are those [//]: for?

This is a Markdown comment intended to prevent unrelated example issues from being unintentionally linked when the contributor has not modified this section of the PR.

Most contributors won't have permission to link issues directly, so it's fine to just display this as plain text instead of using real references.

How about this?

- Fixes #XXX

Reflected in 9f4c8ba

.github/PULL_REQUEST_TEMPLATE.md

dahlia

Could you rebase your commits on the current main branch? It would make your pull request pass the CI builds.

.github/PULL_REQUEST_TEMPLATE.md

dahlia · 2025-07-17T04:16:27Z

Why did you close it?

w8385 · 2025-07-17T04:26:04Z

Why did you close it?

While attempting a reset > pull > rebase workflow, this PR seems to have been accidentally closed.

This happened because I lack experience and knowledge about rebase.

gemini-code-assist bot reviewed Jul 16, 2025

View reviewed changes

github-actions bot added component/integration Web framework integration priority/medium Medium priority issues type/documentation Improvements or additions to documentation labels Jul 16, 2025

gemini-code-assist bot reviewed Jul 16, 2025

View reviewed changes

w8385 force-pushed the main branch from 26fa54e to 3f57ae2 Compare July 16, 2025 18:08

gemini-code-assist bot reviewed Jul 16, 2025

View reviewed changes

.github/ISSUE_TEMPLATE/performance.yml Outdated Show resolved Hide resolved

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

dahlia requested changes Jul 17, 2025

View reviewed changes

dahlia reviewed Jul 17, 2025

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

dahlia requested changes Jul 17, 2025

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

w8385 closed this Jul 17, 2025

w8385 force-pushed the main branch from 9f4c8ba to 0a66a35 Compare July 17, 2025 04:07

w8385 mentioned this pull request Jul 17, 2025

Create Issue and Pull Request Templates #307

Merged

5 tasks

Uh oh!

Conversation

w8385 commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related Issue

Changes

Benefits

Checklist

Additional Notes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

w8385 commented Jul 16, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dahlia Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

w8385 Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

dahlia Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

w8385 Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dahlia left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dahlia commented Jul 17, 2025

Uh oh!

w8385 commented Jul 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

w8385 commented Jul 16, 2025 •

edited

Loading