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

w8385 · 2025-07-17T04:23:27Z

Summary

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

Related Issue

closes 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, e.g.:

- closes #XXX
- fixes #XXX

## 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!

While attempting a reset > pull > rebase workflow, the previous PR (#302) seems to have been accidentally closed.

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!

I've created a suite of new issue and pull request templates for the repository. The primary goal of these additions is to standardize how contributions are made and reported, making it easier for both contributors to submit well-structured information and for maintainers to efficiently manage and prioritize incoming work.

Highlights

Standardized Issue Reporting: I've introduced a comprehensive set of YAML-based issue templates for various types of contributions, including bug reports, feature requests, enhancements, documentation, performance optimizations, refactoring, and test coverage. These templates aim to guide contributors in providing necessary information, improving the quality and consistency of reported issues.
Consistent Pull Request Submissions: I've added a new Markdown-based pull request template to ensure all PRs follow a standardized structure, covering summary, related issues, changes, benefits, and a pre-submission checklist.
Improved Project Management: The introduction of these templates is designed to streamline the contribution process, facilitate better issue triage and prioritization, and encourage consistent communication across the 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.

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

The code changes introduce issue and pull request templates to standardize the contribution process. The templates are well-structured and cover a good range of issue types. A critical syntax error was identified in the chore.yml template, and a suggestion was made to improve the performance.yml template by enforcing the inclusion of benchmarks.

.github/ISSUE_TEMPLATE/chore.yml

.github/ISSUE_TEMPLATE/performance.yml

dahlia · 2025-07-17T04:28:36Z

I think your pull request is not up to date—could you please rebase your commits on the current main branch? E.g.:

git pull --rebase https://github.com/fedify-dev/fedify.git main

w8385 · 2025-07-17T04:42:09Z

I think your pull request is not up to date—could you please rebase your commits on the current main branch? E.g.:
git pull --rebase https://github.com/fedify-dev/fedify.git main

I rebased onto the current main branch and applied some minor changes (e.g., newline at the end of each file, benchmarks marked as required in performance issues).

dahlia · 2025-07-17T06:12:56Z

Could you rebase your commits on the current main branch again?

github-actions · 2025-07-17T10:44:59Z

The docs for this pull request have been published:

https://32abf96a.fedify.pages.dev

…c for performance issue

Update examples displayed in the PR template

github-actions · 2025-07-17T11:13:41Z

The latest push to this pull request has been published to JSR and npm as a pre-release:

Package	Version	JSR	npm
@fedify/fedify	1.8.0-pr.307.1051+73314de1	JSR	npm
@fedify/cli	1.8.0-pr.307.1051+73314de1	JSR
@fedify/amqp	1.8.0-pr.307.1051+73314de1	JSR	npm
@fedify/express	1.8.0-pr.307.1051+73314de1	JSR	npm
@fedify/h3	1.8.0-pr.307.1051+73314de1	JSR	npm
@fedify/postgres	1.8.0-pr.307.1051+73314de1	JSR	npm
@fedify/redis	1.8.0-pr.307.1051+73314de1	JSR	npm

gemini-code-assist bot reviewed Jul 17, 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 17, 2025

gemini-code-assist bot reviewed Jul 17, 2025

View reviewed changes

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

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

w8385 force-pushed the main branch 2 times, most recently from 05f76b0 to 2110e91 Compare July 17, 2025 04:37

w8385 temporarily deployed to github-pages July 17, 2025 10:40 — with GitHub Actions Inactive

w8385 added 16 commits July 17, 2025 19:52

Create Issue and Pull Request Templates

9196f35

Fix input type to textarea and detailed descriptions for body/markdown

1910e52

Update Issue templates seperated

8b85d28

Fix issue names Issue to issue

f9fb546

Update bug report Stemps to Reprodce valdation required

701a8a9

Update chore Reason / Contest validation required

fa9953b

Update performance benefits to benchmarks

da50e91

Update pull request template clearly related issue example

5a26dbf

Update performance issue template to benchmark attribute more specifi…

238dd59

…c for performance issue

Update pull request template h1 to h2

0cbb1e5

Update name format of issue templates and enhance their descriptions

f60519d

Update examples displayed in the PR template

Update pull request template example masking

61eb91e

Update pull request template line

36da116

Update chore template labels key should be a top-level key

10b1d47

Update performance benchmarks required

ee0e882

Update issue templates newline at the end of each file

73314de

w8385 force-pushed the main branch from 6a2bf3f to 73314de Compare July 17, 2025 10:53

w8385 temporarily deployed to github-pages July 17, 2025 11:13 — with GitHub Actions Inactive

dahlia approved these changes Jul 17, 2025

View reviewed changes

dahlia merged commit ecbac73 into fedify-dev:main Jul 17, 2025
18 of 19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Create Issue and Pull Request Templates#307

Create Issue and Pull Request Templates#307
dahlia merged 16 commits intofedify-dev:mainfrom
w8385:main

w8385 commented Jul 17, 2025 •

edited

Loading

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

Uh oh!

Uh oh!

dahlia commented Jul 17, 2025

Uh oh!

w8385 commented Jul 17, 2025

Uh oh!

dahlia commented Jul 17, 2025

Uh oh!

github-actions bot commented Jul 17, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

w8385 commented Jul 17, 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!

dahlia commented Jul 17, 2025

Uh oh!

w8385 commented Jul 17, 2025

Uh oh!

dahlia commented Jul 17, 2025

Uh oh!

github-actions bot commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

w8385 commented Jul 17, 2025 •

edited

Loading

github-actions bot commented Jul 17, 2025 •

edited

Loading