ArtResearch / artresearch.net

ArtResearch ResearchSpace application hosted at https://artresearch.net
5 stars 1 forks source link

Request for Github Issue Templates #500

Closed rafaeluriarte closed 9 months ago

rafaeluriarte commented 9 months ago

Request for Issue Templates

Description: As discussed in our recent Technical Working Group meeting, we are experiencing issues with the clarity and specificity of incoming bug reports, feature requests, and feedback submissions. To address this concern and streamline our issue tracking process, we propose creating issue templates.

Reasoning: During the Technical Working Group meeting, it was highlighted that many issues submitted by users and contributors are often ambiguous and lack essential details. This ambiguity leads to extra work for our team as we need to seek clarifications, which can slow down issue resolution.

Proposed Issue Templates: We suggest creating issue templates for the following categories:

These templates will guide submitters to provide structured and comprehensive information, reducing the need for additional back-and-forth communication.

Additional Information:

The implementation of issue templates would significantly improve the clarity and efficiency of our issue tracking process.

rafaeluriarte commented 9 months ago

Some template suggestions:

  1. Bug Report Template:

    ## Bug Report
    
    **Description:**
    A clear and concise description of the bug.
    
    **Steps to Reproduce:**
    1. 
    2. 
    3. 
    
    **Expected Behavior:**
    A clear and concise description of what you expected to happen.
    
    **Actual Behavior:**
    A clear and concise description of what actually happened.
    
    **Screenshots/Attachments:**
    If applicable, add screenshots or other attachments to help explain the issue.
    
    - Browser/Device:
  2. Feature Request Template:

    ## Feature Request
    
    **Description:**
    A clear and concise description of the feature you are requesting.
    
    **Use Case:**
    Explain how this feature would be beneficial and any specific use cases. Include the steps for achieving this.
    
    **Suggested Implementation:**
    If you have ideas on how this feature could be implemented, please share them here.
  3. Feedback Template:

    ## Feedback
    
    **Description:**
    Share your feedback, suggestions, or general comments about the platform.
    
    **What's working well:**
    List any aspects of the platform that you find positive or well-executed.
    
    **Areas for Improvement:**
    Identify any areas where you believe the platform could be improved.

Any additional templates are necessary? Can make them shorter?

rafaeluriarte commented 9 months ago

solved with #501