Skip to content

chameleonmode/chameleon.app-community

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Efficient Bug Reporting and Enhancement Suggestions 🔍

To help us improve this project, please follow these guidelines when reporting bugs or suggesting enhancements. Clear and well-documented issues help us resolve them faster and enhance our product more effectively. Let's work together to make this project awesome! 🚀

Table of Contents 📑


Bug Reports 🪲

A great bug report helps us understand and reproduce the issue, leading to quicker resolutions. Please provide as many details as possible to speed up the process.

Steps to Report a Bug

  1. Search for Existing Issues: Before opening a new report, check if someone else has already reported the bug.
  2. Create a New Issue: If it hasn't been reported, open a new issue in the repository.
  3. Use the Bug Report Template: Use the template below to provide all the necessary information.

Bug Report Template

Please include the following details in your bug report:

  • Title: A short, descriptive title for the issue.
  • Description: A clear and concise description of the bug.
  • Steps to Reproduce:
    1. Go to '...'
    2. Click on '...'
    3. Scroll down to '...'
    4. See the error
  • Expected Behavior: What you expected to happen.
  • Actual Behavior: What actually happened.
  • Screenshots: Attach screenshots if applicable to help illustrate the problem.
  • Environment: Details about the environment in which the bug was found:
    • OS: (e.g., Windows 10, macOS Big Sur)
    • Browser: (e.g., Chrome 95, Firefox 93)
    • Version: The version of the software where the bug occurs.

Enhancement Suggestions 💡

We value your creativity and ideas! Use the following guidelines to help us understand and evaluate your suggestions effectively.

Steps to Suggest an Enhancement

  1. Check for Similar Suggestions: Search existing issues to see if a similar idea has already been suggested.
  2. Create a New Issue: If the idea hasn't been suggested, open a new issue in the repository.
  3. Use the Enhancement Suggestion Template: Follow the template below to present your idea.

Enhancement Suggestion Template

Please include the following details in your suggestion:

  • Title: A short, descriptive title for the enhancement.
  • Description: A clear and concise description of the enhancement.
  • Current Behavior: Describe the current behavior of the feature you want to improve.
  • Proposed Solution: Provide a detailed description of your proposed change or enhancement.
  • Benefits: Explain how this enhancement will improve the project, such as better user experience, performance, or usability.
  • Additional Context: Include any other relevant information or context.

Labels 🏷️

Please use the appropriate labels when creating issues to help us prioritize and track:

  • Bug: For bugs or unexpected behaviors.
  • Enhancement: For new feature requests or suggestions.

Examples 📝

Providing examples in your bug reports or enhancement suggestions can help us address issues more quickly and accurately.


Thank you for contributing to this project! Your input and support make all the difference. Together, let's make it the best it can be! 🎉