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 template for feature proposal, bugs etc. #9

Open
4 tasks
sarpsahinalp opened this issue Jul 14, 2024 · 0 comments
Open
4 tasks

Create template for feature proposal, bugs etc. #9

sarpsahinalp opened this issue Jul 14, 2024 · 0 comments

Comments

@sarpsahinalp
Copy link
Collaborator

sarpsahinalp commented Jul 14, 2024

Objective:
The goal of this issue is to implement issue templates in our repository to ensure consistent and structured reporting of issues like in Artemis repository.

Problem Statement

Currently, our issue tracking lacks a standardized format, leading to inconsistent and incomplete issue reports. This can result in misunderstandings, delays in resolution, and inefficiencies in our development process.

Proposed Solution

Implementing issue templates will provide a structured framework for reporting bugs, suggesting features, or making inquiries. Each template will guide contributors to include essential details such as steps to reproduce, expected behavior, and relevant context.

Benefits of Issue Templates

  1. Consistency: Ensure every issue report follows a predefined structure, making it easier to understand and address.

  2. Efficiency: Streamline the issue creation process by prompting contributors to provide necessary information upfront, reducing back-and-forth communication.

  3. Clarity: Improve communication and understanding between team members by standardizing the format of issue reports.

  4. Quality: Encourage thoroughness in issue reporting, resulting in higher-quality submissions and faster issue resolution.

Implementation Plan

  1. Template Design: Define templates for common types of issues such as bug reports, feature requests, and general inquiries.

  2. Review and Feedback: Gather feedback from team members on the proposed templates to ensure they meet our needs.

  3. Documentation: Update project documentation to inform contributors about the new issue templates and how to use them effectively.

Next Steps

  • Create and finalize issue templates for bug reports, feature requests, and general inquiries.
  • Test the templates by creating sample issues and ensuring they capture the necessary information.
  • Gather feedback from team members on the usability and effectiveness of the templates.
  • Update project documentation to include instructions on using issue templates.
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

No branches or pull requests

1 participant