📌 Important Guidelines for Issue Creation
Opened this issue · 0 comments
- 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."
- 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.
- Relevant Screenshots/Logs
- If possible, attach screenshots, error logs, or other supporting documents that can help explain the issue better.
- 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).”
- Reference Existing Issues or Pull Requests
- If your issue is related to an existing issue or pull request, link to it for better context.
- Labels
- Choose appropriate labels (like bug, feature request, enhancement) to categorize your issue.
- 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.