Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CREATE CUSTOM ISSUE TEMPLATE #226

Closed
wants to merge 1 commit into from
Closed

Conversation

alo7lika
Copy link
Contributor

Related Issue : #223

Description

Enhancing a custom issue template for the project can significantly enhance the process of issue reporting and tracking. Here’s why it is necessary and some key components to include in your custom issue template:

  • Consistency: A custom template ensures that all issues follow a consistent format, making it easier for contributors and maintainers to understand and categorize them.
  • Clarity: It helps guide users to provide all necessary information, reducing back-and-forth communication for missing details.
  • Efficiency: Streamlining the issue creation process helps contributors focus on the problem rather than figuring out what information is needed.

Key Components to Include in the Template:

  1. Title: A brief summary of the issue.
  2. Description: A detailed explanation of the issue, including steps to reproduce if applicable.
  3. Expected vs. Actual Behavior: What was expected to happen and what actually happened.
  4. Screenshots: Visual evidence of the issue if possible.
  5. Environment Details: Information about the environment where the issue occurred (e.g., OS, browser version).
  6. Labels: Suggested labels for categorizing the issue.

Type of PR

  • Bug fix
  • Feature enhancement
  • Documentation update
  • Other (specify): _______________

Screenshots / videos (if applicable)

N/A

Checklist:

  • I have performed a self-review of my code.
  • I have read and followed the Contribution Guidelines.
  • I have tested the changes thoroughly before submitting this pull request.
  • I have provided relevant issue numbers, screenshots, and videos after making the changes.
  • I have commented my code, particularly in hard-to-understand areas.

Additional context:

This custom issue template aims to facilitate more effective communication between contributors and maintainers, ensuring that issues are reported in a structured manner that includes all necessary details. This will ultimately lead to faster resolutions and better project management.

Copy link
Contributor

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

@alo7lika
Copy link
Contributor Author

@rohitinu6 the task is completed.
kindly merge the PR and assign the labels

@alo7lika
Copy link
Contributor Author

@rohitinu6 the task is completed. kindly merge the PR and assign the labels

the session is going to end in 7 , kindly merge it

Copy link
Collaborator

@Mayureshd-18 Mayureshd-18 left a comment

Choose a reason for hiding this comment

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

@alo7lika Sorry for late reviewing!
Please link the issue using keywords. (fixes/closes..) You can find the detailed info about the same here:
https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword

If needed, please check out merged PRs for reference.

Thanks & regards

@jvedsaqib jvedsaqib closed this Dec 27, 2024
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