Skip to content

Commit 5dc1d40

Browse files
AlexCuadronAlexCuadron
authored
Add comprehensive developer contribution guidelines
* Add comprehensive developer contribution guidelines - Add CONTRIBUTING.md with detailed development guidelines similar to SkyPilot - Update ReadMe_Dev.md with quick development setup guide - Add CHANGELOG.md for tracking project changes - Add GitHub issue templates for bugs and feature requests - Add pull request template with comprehensive checklist - Add development Dockerfile and .dockerignore - Update README.md to reference new contribution guidelines - Include component-specific development guidelines - Add environment variables documentation for developers - Include benchmarking and performance guidelines - Add release process documentation * Remove ReadMe_Dev.md, Dockerfile.dev, and .dockerignore - Remove ReadMe_Dev.md as requested to simplify documentation structure - Remove Dockerfile.dev and .dockerignore files - Update README.md to remove reference to ReadMe_Dev.md - Update CONTRIBUTING.md to replace Docker testing section with clean venv approach - Update CHANGELOG.md to reflect simplified structure
1 parent 9c5916f commit 5dc1d40

7 files changed

Lines changed: 463 additions & 87 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve vCache
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
1. Set up vCache with configuration: '...'
15+
2. Run command: '...'
16+
3. See error
17+
18+
**Expected behavior**
19+
A clear and concise description of what you expected to happen.
20+
21+
**Error message/logs**
22+
If applicable, add error messages or logs to help explain your problem.
23+
24+
```
25+
Paste error message here
26+
```
27+
28+
**Environment (please complete the following information):**
29+
- OS: [e.g. Ubuntu 20.04, macOS 12.0, Windows 11]
30+
- Python version: [e.g. 3.11.0]
31+
- vCache version: [e.g. 0.1.0]
32+
- Poetry version: [e.g. 1.7.0]
33+
34+
**Configuration**
35+
Please share your vCache configuration (remove any sensitive information like API keys):
36+
37+
```python
38+
# Your vCache configuration here
39+
```
40+
41+
**Additional context**
42+
Add any other context about the problem here.
43+
44+
**Tested:**
45+
- [ ] I have tested this with the latest version of vCache
46+
- [ ] I have checked that this issue hasn't been reported before
47+
- [ ] I have included all relevant configuration and environment details

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for vCache
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Use case**
19+
Describe the specific use case or scenario where this feature would be beneficial.
20+
21+
**Implementation suggestions**
22+
If you have ideas about how this could be implemented, please share them here.
23+
24+
**Additional context**
25+
Add any other context, screenshots, or examples about the feature request here.
26+
27+
**Would you be willing to contribute this feature?**
28+
- [ ] Yes, I'd like to work on this
29+
- [ ] I can help with testing
30+
- [ ] I can help with documentation
31+
- [ ] I need help implementing this

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Pull Request
2+
3+
## Description
4+
Brief description of the changes in this PR.
5+
6+
## Type of Change
7+
- [ ] Bug fix (non-breaking change which fixes an issue)
8+
- [ ] New feature (non-breaking change which adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] Documentation update
11+
- [ ] Performance improvement
12+
- [ ] Code refactoring
13+
14+
## Related Issues
15+
Closes #(issue number)
16+
17+
## Changes Made
18+
- List the main changes made in this PR
19+
- Include any new components or modules added
20+
- Mention any breaking changes
21+
22+
## Testing
23+
**Tested:**
24+
- [ ] Unit tests pass (`poetry run pytest tests/unit`)
25+
- [ ] Integration tests pass (`poetry run pytest tests/integration`)
26+
- [ ] Pre-commit hooks pass (`poetry run pre-commit run --all-files`)
27+
- [ ] Manual testing performed
28+
29+
**Test Details:**
30+
Describe the testing you performed to verify your changes work correctly.
31+
32+
## Performance Impact
33+
If applicable, describe any performance implications of your changes:
34+
- [ ] No performance impact
35+
- [ ] Performance improvement (include benchmarks)
36+
- [ ] Potential performance regression (explain why necessary)
37+
38+
## Documentation
39+
- [ ] Updated docstrings for new/modified functions
40+
- [ ] Updated README.md if needed
41+
- [ ] Updated CONTRIBUTING.md if needed
42+
- [ ] Added/updated examples if applicable
43+
44+
## Checklist
45+
- [ ] My code follows the project's coding guidelines
46+
- [ ] I have performed a self-review of my code
47+
- [ ] I have commented my code, particularly in hard-to-understand areas
48+
- [ ] I have made corresponding changes to the documentation
49+
- [ ] My changes generate no new warnings
50+
- [ ] I have added tests that prove my fix is effective or that my feature works
51+
- [ ] New and existing unit tests pass locally with my changes
52+
53+
## Additional Notes
54+
Any additional information that reviewers should know about this PR.

‎CHANGELOG.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
- Comprehensive developer contribution guidelines in CONTRIBUTING.md
12+
- Architecture overview for developers
13+
- Component-specific development guidelines
14+
- Environment variables documentation for developers
15+
- Benchmarking and performance guidelines
16+
- Release process documentation
17+
- GitHub issue templates for bugs and feature requests
18+
- Pull request template with comprehensive checklist
19+
20+
### Changed
21+
- Restructured developer documentation for better organization
22+
- Updated README.md to reference new contribution guidelines
23+
- Simplified developer documentation structure
24+
25+
### Documentation
26+
- Added detailed coding standards and best practices
27+
- Included testing guidelines for unit and integration tests
28+
- Added component-specific development instructions
29+
- Enhanced pre-commit hook documentation
30+
31+
## [0.1.0] - 2025-01-XX
32+
33+
### Added
34+
- Initial release of vCache
35+
- Core semantic caching functionality
36+
- Dynamic local threshold policy
37+
- Support for multiple inference engines (OpenAI, Anthropic, etc.)
38+
- Support for multiple vector databases (FAISS, HNSWLib, ChromaDB)
39+
- Comprehensive benchmarking framework
40+
- Unit and integration test suites
41+
- Poetry-based dependency management
42+
- Pre-commit hooks for code quality
43+
44+
### Features
45+
- Verified semantic prompt caching with error rate bounds
46+
- Modular architecture for easy extensibility
47+
- Multiple embedding engines support
48+
- Configurable similarity evaluators
49+
- Performance monitoring and statistics
50+
- Benchmark datasets and evaluation tools
51+
52+
### Documentation
53+
- Comprehensive README with usage examples
54+
- Developer setup guide
55+
- Testing documentation
56+
- Benchmarking documentation
57+
- API documentation

0 commit comments

Comments
 (0)