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

Merged
merged 1 commit into from
Nov 10, 2024
Merged

CREATE CUSTOM ISSUE TEMPLATE #187

merged 1 commit into from
Nov 10, 2024

Conversation

alo7lika
Copy link
Contributor

@alo7lika alo7lika commented Nov 9, 2024

Related Issue : #169

Description

Creating 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

vercel bot commented Nov 9, 2024

@alo7lika is attempting to deploy a commit to the Adarsh Maurya's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

deepsource-io bot commented Nov 9, 2024

Here's the code health analysis summary for commits bb6a306..39b51eb. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Shell LogoShell✅ SuccessView Check ↗
DeepSource JavaScript LogoJavaScript✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@alo7lika
Copy link
Contributor Author

alo7lika commented Nov 9, 2024

@4darsh-Dev the task has been completed. Kindly review the PR
Don't forget to add label "GSSOC-EXT"

@alo7lika
Copy link
Contributor Author

@4darsh-Dev the task has been completed. Kindly review the PR Don't forget to add the label "GSSOC-EXT"

@4darsh-Dev the session is going to get over , Kindly merge the PR

Copy link
Owner

@4darsh-Dev 4darsh-Dev left a comment

Choose a reason for hiding this comment

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

fine 👍🏻

@4darsh-Dev 4darsh-Dev added documentation Improvements or additions to documentation level1 gssoc-ext labels Nov 10, 2024
@4darsh-Dev 4darsh-Dev merged commit 5b78ba8 into 4darsh-Dev:main Nov 10, 2024
8 of 11 checks passed
@4darsh-Dev
Copy link
Owner

Gentle Reminder 🚨🚨
PA and Mentor nominations have been started for GSSoC-Ext 2k24. '
Do share your experiences and connect on Socials. '
It was a great experience working with you all
Thanks💗 for your valuable contributions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation gssoc-ext level1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants