AdaptiveShell
    Preparing search index...

    Contributing to AdaptiveShell

    :+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

    How Can I Contribute?

    Reporting Bugs

    Useful Links


    TODO


    This guide helps you submit effective bug reports for our projects. Clear, detailed reports help maintainers and the community understand, reproduce, and resolve issues efficiently.

    Before Submitting A Bug Report

    Before creating a new report, please review this list to avoid duplicate submissions. When reporting bugs, include comprehensive details and use our template to ensure all necessary information is provided.

    Note

    If you find a closed issue similar to your current problem, please create a new issue and reference the original one in your description as that will help us find the regression way faster.

    Bugs are tracked as GitHub issues. Create an issue in our repository and provide detailed information using our template.

    To help us resolve issues quickly, please include:

    1. Title: Use a clear, descriptive title that identifies the problem.

    2. Steps to Reproduce:

      • Detail exactly how to reproduce the issue
      • Explain how you started AdaptiveShell
      • Include the specific commands or actions used
      • Be precise about what you did and how you did it
    3. Examples and Evidence:

      • Provide specific examples demonstrating the issue
      • Include code snippets using Markdown code blocks
      • Add screenshots or GIFs if relevant
      • For crashes, include the full error message in a code block or gist
    4. Expected vs Actual Behavior:

      • Describe what you observed
      • Explain what you expected to happen
      • Clarify why the current behavior is problematic
    5. Context:

      • When did the issue start?
      • Which version of AdaptiveShell are you using?
      • What's your operating system and version?
      • Are you using a virtual machine? If yes, specify the VM software and configurations
    6. Reproducibility:

      • Can you consistently reproduce the issue?
      • If intermittent, describe the conditions when it occurs

    Remember: The more detailed your report, the faster we can identify and fix the issue!