From ec6cfdf30408afbf98fcc54babb442ddb63d69dc Mon Sep 17 00:00:00 2001 From: KaifAhmad1 Date: Thu, 18 Dec 2025 22:14:02 +0530 Subject: [PATCH] Update docs: Enhance CONTRIBUTING.md with performance section & add Contributors widget to README --- CONTRIBUTING.md | 21 +++++++++++++++------ README.md | 7 +++++++ 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4acc089c..60a50f90 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -326,14 +326,23 @@ def extract_entities( ## Types of Contributions -### Code Contributions +### 💻 Code Contributions -- Bug fixes -- New features -- Performance improvements -- Refactoring +- **Bug Fixes**: Resolving issues reported in the issue tracker. +- **New Features**: Implementing new capabilities (please discuss via an issue first!). +- **Refactoring**: Improving code structure and maintainability without changing behavior. +- **Algorithm Optimization**: Improving the efficiency of graph algorithms and vector search. -### Documentation Contributions +#### ⚡ Performance and Latency +We deeply value efficiency. Contributions that make Semantica faster and lighter are highly appreciated! + +- **Latency Reduction**: Optimizing critical paths, reducing function call overhead, and improving response times for RAG pipelines. +- **Memory Optimization**: Reducing memory footprint during graph processing and vector operations. +- **Throughput**: Improving the number of operations processed per second (e.g., bulk ingestion, parallel queries). +- **Benchmarks**: Adding performance benchmarks to track regressions. +- **Async/Concurrency**: Improving asynchronous execution and concurrency handling. + +### 📚 Documentation Contributions - Fix typos and grammar - Improve clarity diff --git a/README.md b/README.md index 6ef20746..6c83cac3 100644 --- a/README.md +++ b/README.md @@ -585,6 +585,7 @@ git push origin feature/your-feature 2. **Documentation** - Improvements, tutorials 3. **Bug Reports** - [Create issue](https://github.com/Hawksight-AI/semantica/issues/new) 4. **Feature Requests** - [Request feature](https://github.com/Hawksight-AI/semantica/issues/new) +5. **Performance and Latency** - Improve Speed, Performance, and Speedup Semantica ### Recognition @@ -594,6 +595,12 @@ Contributors receive: - Semantica swag - Featured showcases +## 🌟 Contributors + + + + + ## 📜 License Semantica is licensed under the **MIT License** - see the [LICENSE](https://github.com/Hawksight-AI/semantica/blob/main/LICENSE) file for details.