HOW TO SUBMIT ISSUE [ MUST READ ]

[Moshiii]

Reporting Issues and Requesting Features

Welcome to ISEK! We use GitHub Issues to track bug reports, feature requests, and other discussions related to Isek. Your feedback is invaluable in helping us improve the framework.

Before Submitting an Issue

To help us address your issue effectively, please consider the following before submitting:

1. Search Existing Issues: Check if your issue or feature request has already been reported or discussed. You can search https://github.com/isekOS/ISEK/issues to avoid duplicates. If you find a similar issue, feel free to add your comments or a "👍" reaction to it.

2. Ensure You're on the Latest Version: If you're reporting a bug, try to reproduce it with the latest version of Isek. You can update by running:

   pip install --upgrade isek

How to Submit a Good Issue

When you're ready to submit an issue:

1. Go to https://github.com/isekOS/ISEK/issues.

2. Click on the "New issue" button.

3. Choose an Issue Template (working in progress): We may provide templates for "Bug Report" or "Feature Request." Using a template helps ensure you provide all the necessary information.

4. Write a Clear and Concise Title: The title should briefly summarize the problem or suggestion.

   • Good Title (Bug): Distributed agent fails to connect when registry is on a different host
   • Good Title (Feature): Add support for custom message serialization formats
   • Bad Title: It's broken!

5. Provide Detailed Information in the Body:

   • For Bug Reports:

     • Provide python version, isek version, OS info.
     • Describe the bug clearly.
     • List the exact steps to reproduce it.
     • Explain what you expected to happen.
     • Explain what happened (include full error messages and stack traces, formatted as code blocks).
     • Provide your environment details (Isek version, Python version, OS).

   • For Feature Requests:

     • Clearly describe the proposed feature and its use case.
     • Explain why this feature would be beneficial to Isek users.
     • (Optional) Suggest how it might be implemented.

6. Use Markdown for Formatting: Use Markdown to format code blocks, lists, and other elements for better readability. (For example, use triple backticks ``` for code blocks).

7. Be Responsive: After submitting, be prepared to answer questions or provide more information if requested by the maintainers.

Issue Labels

We use labels to categorize and manage issues. Some common labels you might see include:

• bug: A confirmed bug in the code.
• enhancement or feature request: A new feature or improvement.
• documentation: Issues related to documentation.
• question: For questions that might lead to a bug report or feature request.
• good first issue: Issues that are relatively easy for new contributors to tackle.
• help wanted: Issues where we're actively seeking community contributions.

Thank you for helping make ISEK Community better. Lets build the future together!