Katty is a flexible and organized repository template designed for my data science projects in Taipy.
This project is designed to accomplish the following:
- Mypy Compliance: Guarantee adherence to type-checking standards using mypy to enhance code reliability and readability.
- Comprehensive Test Coverage: Strive for thorough test coverage to ensure all aspects of the project function as expected.
- Optimized CI/CD Workflows: Develop effective CI/CD workflows to automate testing and deployment, streamlining the development process.
- Compatibility with Older Python Versions (>= 3.8): Maintain support for older Python versions to expand accessibility for a wider user base.
- Clear and Informative Documentation: Create straightforward documentation to assist users in navigating and understanding the project.
- Examples of Best and Worst Practices: Include examples in the documentation to guide users toward effective implementation techniques.
- Practical Use Case Project: Build a real-world example project that showcases the template's effective usage.
- Robust and Resilient Design: Engineer the project to handle edge cases and sustain performance across varying conditions.
- Scalability Focus: Ensure the architecture is designed for easy growth and adaptability for future enhancements.
Thank you for considering contributing to this Taipy project template! To ensure a smooth collaboration, please follow these guidelines when submitting issues or feature requests.
- Check Existing Issues: Before submitting a new issue, please check if it has already been reported.
- Provide Clear Descriptions: Include a clear and concise title and description of the issue. Steps to reproduce, expected behavior, and any relevant screenshots or error messages are helpful.
- Label Appropriately: If possible, label your issue with relevant tags (e.g., bug, enhancement).
- Research Before Requesting: Before submitting a feature request, please ensure it’s not already planned or in progress.
- Be Specific: Describe the feature in detail, including its benefits and how it would enhance the template.
- Use Examples: If applicable, provide examples of how the feature could be implemented or used.
We appreciate your contributions and look forward to improving this project together!
This project is licensed under the MIT License. See the LICENSE file for more details.