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

Proposal: Introduce Issue Templates #418

Open
hiroyukikumazawa opened this issue Nov 18, 2024 · 5 comments
Open

Proposal: Introduce Issue Templates #418

hiroyukikumazawa opened this issue Nov 18, 2024 · 5 comments
Assignees

Comments

@hiroyukikumazawa
Copy link
Contributor

Overview

To improve consistency and clarity in issue reporting, I propose introducing standardized issue templates for the Akash website repository. This will ensure that contributors have a structured format to report bugs, request features, or suggest improvements.


Why is this important?

  1. Improved Communication: Templates provide clear guidance on the details needed for each type of issue.
  2. Enhanced Collaboration: Well-structured issues help maintainers and contributors understand and address concerns faster.
  3. Consistency: Standardization reduces ambiguity and increases efficiency.

Proposed Templates

  1. Bug Report

    • Template to include:
      • Steps to reproduce
      • Expected behavior
      • Actual behavior
      • Environment (browser, OS, etc.)
  2. Feature Request

    • Template to include:
      • Problem statement
      • Proposed solution
      • Any additional context
  3. General Inquiry

    • Template to include:
      • Description of the inquiry or suggestion
      • Relevant context
@hylcore-V
Copy link

This is an excellent proposal for improving issue reporting and resolution.
I fully support the introduction of standardized issue templates, as they will undoubtedly enhance communication, collaboration, and consistency in managing issues.

I would like to suggest an additional enhancement: incorporating an issue reporting page or section on the Akash website.
This page could feature structured forms aligned with the proposed templates (Bug Report, Feature Request, General Inquiry).
By doing so, contributors can submit issues directly from the website in a more user-friendly and structured manner.

This approach would:

  • Improve Accessibility: Allow contributors who may not be familiar with GitHub to easily report issues.
  • Enhance Readability: Provide a clear and consistent format for all submissions.
  • Streamline the Process: Automatically organize and format reports, ensuring they align with the standards set by the templates.

Adding this feature would complement the templates and make issue reporting more intuitive and efficient, ultimately benefiting the Akash community.

@HoomanDgtl
Copy link
Contributor

really like the idea of introducing template, lets discuss this more during next wg-website call and it would also be great if you can mention the no of hrs for this issue. thanks

@hylcore-V
Copy link

really like the idea of introducing template, lets discuss this more during next wg-website call and it would also be great if you can mention the no of hrs for this issue. thanks

Thank you for your reply.
I will considered about the hours

@hiroyukikumazawa
Copy link
Contributor Author

really like the idea of introducing template, lets discuss this more during next wg-website call and it would also be great if you can mention the no of hrs for this issue. thanks

1 hour

@HoomanDgtl
Copy link
Contributor

@hiroyukikumazawa as discussed over meet, you can create templated for simple things like: bugs, text mistake etc..
maybe 2-3 issue template might be good.

thanks

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

3 participants