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

📌 Important Guidelines for Issue Creation #44

Closed
vivekvardhan2810 opened this issue Oct 1, 2024 · 0 comments
Closed

📌 Important Guidelines for Issue Creation #44

vivekvardhan2810 opened this issue Oct 1, 2024 · 0 comments

Comments

@vivekvardhan2810
Copy link
Member

vivekvardhan2810 commented Oct 1, 2024

  1. Clear and Descriptive Title
  • Provide a concise and informative title that reflects the core issue or idea.

  • Avoid vague titles like "Bug" or "New Feature". Instead, use specifics like "Fix alignment issue on homepage" or "Add dark mode support."

  1. Detailed Issue Description
  • Summary: Include a brief description of the issue or feature request.

  • Steps to Reproduce (For bugs): Provide a clear, step-by-step guide to reproduce the problem.

  • Expected Behavior: Describe what should happen.

  • Actual Behavior: Describe what is happening.

  • Proposed Solution (For new features): Explain your proposed solution or idea clearly, mentioning how it benefits the project.

  1. Relevant Screenshots/Logs
  • If possible, attach screenshots, error logs, or other supporting documents that can help explain the issue better.
  1. Tech Stack Mention
  • If you’re suggesting a project or feature in a different tech stack, specify the tech stack you'll be using.
    Example: “Recreate the To-Do list app in Python (currently available in JavaScript).”
  1. Reference Existing Issues or Pull Requests
  • If your issue is related to an existing issue or pull request, link to it for better context.
  1. Labels
  • Choose appropriate labels (like bug, feature request, enhancement) to categorize your issue.
  1. One Issue per Submission
  • Do not combine multiple unrelated issues in a single submission. Raise separate issues for each.

  • Dont create a issue on some feature which was already raised by someone else before.

Please follow the above guidelines before creating an issue.

@vivekvardhan2810 vivekvardhan2810 pinned this issue Oct 1, 2024
@ML-Fusion-Lab ML-Fusion-Lab locked as off-topic and limited conversation to collaborators Oct 1, 2024
@vivekvardhan2810 vivekvardhan2810 unpinned this issue Oct 29, 2024
@vivekvardhan2810 vivekvardhan2810 pinned this issue Oct 29, 2024
@vivekvardhan2810 vivekvardhan2810 unpinned this issue Nov 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant