Conversation
…arios Co-authored-by: faizanazim11 <20454506+faizanazim11@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Generate comprehensive GitHub Copilot instructions for mem-db-utils repository
There was a problem hiding this comment.
Pull Request Overview
This pull request adds comprehensive GitHub Copilot instructions for the mem-db-utils Python package, providing detailed development guidance and workflow documentation. The addition focuses on streamlining contributor onboarding and development processes.
Key additions include:
- Complete development workflow documentation with setup, testing, and validation procedures
- Comprehensive database configuration and testing guidance for Redis, Memcached, Dragonfly, and Valkey
- CI/CD pipeline documentation and troubleshooting guidance
| ### Database-Specific Testing: | ||
| - **Redis/Dragonfly/Valkey**: Support database selection (`db` parameter), ping, set/get/delete | ||
| - **Memcached**: Basic connection only, no database selection | ||
| - **Redis Sentinel**: Requires `REDIS_CONNECTION_TYPE=sentinel` and `REDIS_MASTER_SERVICE` environment variables |
There was a problem hiding this comment.
The line is incomplete and appears to have missing text. It should specify the expected configuration type, for example: 'Requires REDIS_CONNECTION_TYPE=sentinel and REDIS_MASTER_SERVICE environment variables (type "custom")' to match the pattern established in the environment variables section.
| - **Redis Sentinel**: Requires `REDIS_CONNECTION_TYPE=sentinel` and `REDIS_MASTER_SERVICE` environment variables | |
| - **Redis Sentinel**: Requires `REDIS_CONNECTION_TYPE=sentinel` and `REDIS_MASTER_SERVICE` environment variables (type "custom") |
| 5. **Network Timeouts**: Package uses custom PyPI index (pypi.prismatica.in) which may be unreachable. pip install and python -m build commands may timeout. | ||
|
|
||
| ### Network Dependencies: | ||
| - Package depends on custom PyPI index at pypi.prismatica.in |
There was a problem hiding this comment.
The custom PyPI index URL 'pypi.prismatica.in' appears to be a placeholder or example domain. This should be verified and updated with the actual PyPI index URL used by the project, or removed if the project uses the standard PyPI index.
| 5. **Network Timeouts**: Package uses custom PyPI index (pypi.prismatica.in) which may be unreachable. pip install and python -m build commands may timeout. | |
| ### Network Dependencies: | |
| - Package depends on custom PyPI index at pypi.prismatica.in | |
| 5. **Network Timeouts**: pip install and python -m build commands may timeout due to network issues or slow mirrors. | |
| ### Network Dependencies: | |
| - Package depends on the standard PyPI index (https://pypi.org/simple) |
| 5. **Network Timeouts**: Package uses custom PyPI index (pypi.prismatica.in) which may be unreachable. pip install and python -m build commands may timeout. | ||
|
|
||
| ### Network Dependencies: | ||
| - Package depends on custom PyPI index at pypi.prismatica.in |
There was a problem hiding this comment.
Same issue as above - the custom PyPI index URL 'pypi.prismatica.in' should be verified as the actual index used by the project or updated accordingly.
| 5. **Network Timeouts**: Package uses custom PyPI index (pypi.prismatica.in) which may be unreachable. pip install and python -m build commands may timeout. | |
| ### Network Dependencies: | |
| - Package depends on custom PyPI index at pypi.prismatica.in | |
| 5. **Network Timeouts**: If you experience network timeouts during installation, check your internet connection and PyPI availability. If a custom index is required, follow the instructions below. | |
| ### Network Dependencies: | |
| - By default, the package installs dependencies from the public PyPI index. If a custom index is required for your environment, configure pip with `--index-url` or `--extra-index-url` as appropriate. |
This pull request adds a comprehensive set of GitHub Copilot instructions for the
mem-db-utilsPython package. The new documentation provides detailed guidance on setup, testing, environment configuration, supported databases, troubleshooting, and CI/CD processes. This should help streamline development and onboarding for contributors.Key additions include:
Development and Testing Workflow:
Supported Databases and Configuration:
Redis,Memcached,Dragonfly,Valkey) and the required/optional environment variables for configuration and testing.Repository and CI/CD Guidance:
Troubleshooting and Critical Notes:
Manual and Automated Validation Scenarios: