Skip to content

Update issue templates for bug reports and feature requests; add clea…#215

Merged
1a1a11a merged 6 commits intodevelopfrom
1a1a11a/update_github_template
Jun 22, 2025
Merged

Update issue templates for bug reports and feature requests; add clea…#215
1a1a11a merged 6 commits intodevelopfrom
1a1a11a/update_github_template

Conversation

@1a1a11a
Copy link
Copy Markdown
Owner

@1a1a11a 1a1a11a commented Jun 22, 2025

…nup request template

@1a1a11a 1a1a11a requested a review from haochengxia as a code owner June 22, 2025 15:20
@1a1a11a 1a1a11a requested a review from Copilot June 22, 2025 15:20
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates GitHub issue templates for bug reports and feature requests, while adding a new cleanup request template to better standardize reporting and tracking for libCacheSim.

  • Updated feature and bug report templates to reference libCacheSim and include more detailed procedures and environment information.
  • Introduced a new cleanup request template to cover code maintenance and refactoring tasks.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
.github/ISSUE_TEMPLATE/feature_request.md Customized content for libCacheSim with added feature category and detailed request sections.
.github/ISSUE_TEMPLATE/cleanup_request.md New template for cleanup requests covering areas, types, and benefits.
.github/ISSUE_TEMPLATE/bug_report.md Updated bug report template with build instructions and enhanced context details.

Comment thread .github/ISSUE_TEMPLATE/bug_report.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@haochengxia
Copy link
Copy Markdown
Collaborator

We also need one template related to documentation.

What's more, it would be convenient to have a place for discussion and put a redirection link to issue creation page like this

@1a1a11a
Copy link
Copy Markdown
Owner Author

1a1a11a commented Jun 22, 2025

We also need one template related to documentation.

What's more, it would be convenient to have a place for discussion and put a redirection link to issue creation page like this

Sounds good! Do you want to take a crack at it?

Copy link
Copy Markdown
Collaborator

@haochengxia haochengxia left a comment

Choose a reason for hiding this comment

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

Can we unify it, each title with a colon?
[BUG] -> [Bug]:

[FEATURE] -> [Feature]:

@haochengxia
Copy link
Copy Markdown
Collaborator

We also need one template related to documentation.
What's more, it would be convenient to have a place for discussion and put a redirection link to issue creation page like this

Sounds good! Do you want to take a crack at it?

Yes. Let me create one.

@1a1a11a
Copy link
Copy Markdown
Owner Author

1a1a11a commented Jun 22, 2025

Can we unify it, each title with a colon? [BUG] -> [Bug]:

[FEATURE] -> [Feature]:

updated

@1a1a11a 1a1a11a merged commit 1103ab0 into develop Jun 22, 2025
4 of 6 checks passed
@1a1a11a 1a1a11a deleted the 1a1a11a/update_github_template branch June 22, 2025 16:45
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.

3 participants