Skip to content

Issue Tracking

Zacharie edited this page Jul 19, 2023 · 1 revision

Issue Tracking with PynamicUI

This page serves as a guide on how to raise an issue, report bugs, suggest enhancements, and ask questions related to PynamicUI.

How to Raise an Issue

If you encounter any problems or have questions, you can raise an issue on our GitHub repository. Here's how you can do it:

  1. Check Existing Issues: Before opening a new issue, take a moment to search the existing issues to see if your problem or question has already been addressed.

  2. Create a New Issue: If your issue is not already listed, navigate to the Issues tab on our GitHub repository.

  3. Issue Title: Create a descriptive and concise title that clearly summarizes the problem you are facing or the request you have.

  4. Detailed Description: In the issue description, provide as much relevant information as possible. Include any error messages, logs, or steps to reproduce the issue. The more details you provide, the easier it will be for us to understand and resolve the problem.

  5. Use Labels: Choose appropriate labels to categorize your issue. For example, use "bug" for bug reports, "enhancement" for feature requests, and "question" for general inquiries.

  6. Version Checking: If applicable, include the version of [Your Library Name] you are currently using. This information can help us pinpoint the issue and provide a better solution.

  7. Providing Operating System Information: If relevant, include details about the operating system you are using. This information can also be helpful in troubleshooting.

  8. Be Respectful and Courteous: Our community thrives on respect and cooperation. Please be polite in your interactions with others and understand that everyone's time is valuable.

How to Find the Version of [Your Library Name]

You can find the version of [Your Library Name] installed in your environment by running the following code:

import pynamicui

print(pynamicui.__version__)

Providing Operating System Information

The operating system you are using can impact the behavior of [Your Library Name]. Here's how you can find and provide this information:

  • Windows: Click on the Start button, type "System Information," and press Enter. Under "System Summary," find the "OS Name" and "OS Version" fields.

  • macOS: Click on the Apple menu and select "About This Mac." Note down the version information provided.

  • Linux: Open a terminal and run the following command: lsb_release -a. Note down the Distributor ID, Description, Release, and Codename.

Conclusion

By following these guidelines and providing relevant information, you can help us efficiently address issues and improve PynamicUI for everyone. We appreciate your contributions to the community and thank you for being part of our journey!

If you have any further questions or need assistance, feel free to reach out on our GitHub Issues page.

Happy coding! 🚀