Skip to content

Creating issue posts

Hamish Leahy edited this page Sep 28, 2023 · 1 revision

Issue Reporting Policy

Welcome to the Issue Reporting Policy for the Machine Learning Playground repository. We appreciate your contributions to improving this project's quality by reporting issues and problems you encounter. To ensure efficient and effective issue tracking and resolution, please follow the guidelines outlined below:

Types of Issues

  1. Bug Reports: If you encounter a bug, glitch, or unexpected behavior in any of the notebooks or the repository as a whole, please report it as a "Bug."

  2. Feature Requests: If you have a suggestion for a new feature, enhancement, or addition to the Machine Learning Playground, please report it as a "Feature Request." We welcome your ideas for improving this resource.

  3. Notebook-Specific Issues: If the issue is specific to a particular notebook (e.g., errors, inaccuracies, or improvements), please mention the notebook's title in your issue report.

Reporting Guidelines

When reporting an issue, please adhere to the following guidelines to help us understand and address the problem efficiently:

  1. Clear and Descriptive Title: Use a clear and descriptive title that summarizes the issue concisely.

  2. Detailed Description: Provide a detailed description of the issue, including:

    • The steps to reproduce the problem, if applicable.
    • The expected behavior.
    • The actual behavior or error messages encountered.
  3. Environment Information: Specify relevant details about your environment, such as:

    • Operating system (e.g., Windows 10, macOS 11).
    • Python version (e.g., Python 3.8).
    • Any specific libraries or dependencies used.
  4. Screenshots or Code Snippets: If relevant, include screenshots or code snippets that illustrate the issue.

Responsible Reporting

We encourage responsible and respectful reporting of issues. Please:

  • Do not engage in disrespectful, offensive, or harmful behavior.
  • Refrain from posting duplicate issues; search for existing issues first.
  • Avoid sharing sensitive or private information.

Issue Resolution

Our team will review and address reported issues as promptly as possible. We may request additional information or clarification if needed. You will receive updates on the progress of your issue, including when it is resolved or closed.

Community Collaboration

We appreciate your collaboration in improving the Machine Learning Playground. Feel free to participate in issue discussions, offer solutions or suggestions, and provide feedback to help make this resource even better.

Thank you for your contributions and for helping us maintain a high-quality repository.