Skip to content

Feat/ Enhance Issue Templates#333

Merged
kevin-mindverse merged 5 commits intomasterfrom
feat/newIssueTemplate
May 8, 2025
Merged

Feat/ Enhance Issue Templates#333
kevin-mindverse merged 5 commits intomasterfrom
feat/newIssueTemplate

Conversation

@kevin-mindverse
Copy link
Copy Markdown
Contributor

This PR introduces several improvements to our GitHub issue templates (bug-report.yml and feature-request.yml) to streamline the issue submission process and gather more comprehensive information upfront.

Bug Report Template (.github/ISSUE_TEMPLATE/bug-report.yml)

The bug-report.yml template has been significantly updated to help users provide more structured and detailed information:

  1. Added Initial Information Collection:
    • New checkboxes have been added at the beginning of the form to collect essential environment details:
      • Operating System: (macOS, Linux, Windows)
      • Deployment Method: (Docker, non-Docker)
      • CUDA Usage: (Yes, No)
    • A conditional section has been included for issues related to the training process:
      • Users are prompted to provide Model size (e.g., 7B, 13B).
      • Users are asked for Machine base configuration (RAM size and VRAM size).
  2. Improved Field Descriptions:
    • The description for "Second-Me version" now explicitly mentions that users can provide a commit id, release tag, or specify if they are on the latest master.
    • The "Describe the bug" section (id: description) has been refined. It now prompts users to:
      • Clearly describe the current behavior versus the expected behavior.
      • Include relevant error messages from console logs, specifically mentioning log/backend.log for backend-related issues.
  3. Guideline Placement:
    • The important guidelines section (telling users to check existing issues and discuss first) has been moved to the top of the template for better visibility.

Rationale for bug-report.yml changes:
These modifications aim to reduce back-and-forth communication by ensuring that crucial details are provided when a bug is first reported. This will help developers diagnose and address issues more efficiently.

Feature Request Template (.github/ISSUE_TEMPLATE/feature-request.yml)

A minor but important update has been made to the feature-request.yml template:

  1. Updated Discord Link:
    • The Discord server invitation link within the introductory guidelines has been corrected/updated to ensure users can access our community discussion channels.

Overall Goal:
The enhancements in this PR are designed to improve the quality of issue reports and feature requests, making the development and issue-tracking process smoother for both the community and the maintainers.

@kevinaimonster kevinaimonster self-requested a review May 7, 2025 08:03
Copy link
Copy Markdown
Contributor

@kevinaimonster kevinaimonster left a comment

Choose a reason for hiding this comment

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

Good Job!

@kevinaimonster kevinaimonster requested a review from yingapple May 7, 2025 08:27
@kevin-mindverse kevin-mindverse merged commit 1e7d607 into master May 8, 2025
1 check passed
keitheis pushed a commit to keitheis/Second-Me that referenced this pull request May 10, 2025
* feat: add new issue template

* new version template

* new category

* fix link

* optimize description
Cybercricetus pushed a commit to Cybercricetus/Second-Me that referenced this pull request May 29, 2025
* feat: add new issue template

* new version template

* new category

* fix link

* optimize description
EOMZON pushed a commit to EOMZON/Second-Me that referenced this pull request Feb 1, 2026
* feat: add new issue template

* new version template

* new category

* fix link

* optimize description
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