352 Issue Creation Guidlines

🚀 Issue Creation Guidelines

Introduction ⭐

Welcome to our project's issue guidlines ! This document outlines guidelines for creating issues effectively, helping us to manage and prioritize tasks efficiently.

Before Creating an Issue ⚠️

• Before you create a new issue, please check if a similar issue already exists. This helps avoid duplication of efforts and keeps our issue tracker organized. You can search existing issues by using the search bar at the top of the issues page.
• Please note that we have a predefined issue template for conventions, which should be utilized by contributors when creating new issues.

Creating a New Issue 🚨

When creating a new issue, please follow these guidelines:

Title 📝

Choose a descriptive title that summarizes the issue concisely. Avoid generic titles like "Bug fix" or "Feature request". Instead, be specific about the problem or feature.

Description ✍️

Provide a detailed description of the issue, including:

• Steps to Reproduce (for bugs): Clearly outline the steps to reproduce the bug. This helps us understand the problem and investigate it efficiently.
• Expected Behavior: Describe what you expected to happen.
• Actual Behavior: Describe what actually happened.
• Screenshots (if applicable): Include screenshots or recordings if they help illustrate the issue.
• Context (for feature requests): Explain the context or use case for the feature request. Help us understand why it's important and how it would benefit the project.

Labels 🏷️

Assign appropriate labels to the issue to categorize it. Common labels may include "bug", "feature", "enhancement","priority" "documentation", etc. This helps us prioritize and filter issues.

Assignees ✋

Assign the issue to the appropriate person or team responsible for addressing it. If you're unsure, you can leave it unassigned, and decide with team who will pick it up.

Additional Information ➕

Include any additional information that might be relevant to the issue, such as environment details, error messages, or related issues.

Prepeared by Enes Baser