Skip to content

Commit 486bbcd

Browse files
committed
fix: remove unused code & add coontribute doc
1 parent 03e9aa2 commit 486bbcd

23 files changed

+547
-2048
lines changed

CONTRIBUTING.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Contributing to MineContext
2+
3+
Thank you for your interest in contributing to MineContext! We welcome contributions from the community.
4+
5+
## Getting Started
6+
7+
### Development Setup
8+
9+
1. **Fork and clone the repository**
10+
11+
```bash
12+
git clone https://github.com/YOUR_USERNAME/MineContext.git
13+
cd MineContext
14+
```
15+
2. **Set up your environment**
16+
17+
```bash
18+
python -m venv venv
19+
source venv/bin/activate # On Windows: venv\Scripts\activate
20+
pip install -r requirements.txt
21+
```
22+
3. **Configure and run**
23+
24+
```bash
25+
# Start the server
26+
python -m opencontext.cli start
27+
```
28+
29+
## How to Contribute
30+
31+
### Reporting Issues
32+
33+
Found a bug or have a feature request? [Create an issue](https://github.com/volcengine/MineContext/issues) with:
34+
35+
- Clear description of the problem or feature
36+
- Steps to reproduce (for bugs)
37+
- Your environment (OS, Python version, MineContext version)
38+
39+
### Submitting Code
40+
41+
1. **Create a branch**
42+
43+
```bash
44+
git checkout -b feature/your-feature-name
45+
```
46+
2. **Make your changes**
47+
48+
- Follow [PEP 8](https://pep8.org/) style guidelines
49+
- Add tests for new features
50+
- Update documentation if needed
51+
3. **Commit with clear messages**
52+
53+
```bash
54+
git commit -m "feat: add your feature description"
55+
# or
56+
git commit -m "fix: fix your bug description"
57+
```
58+
4. **Push and create a Pull Request**
59+
60+
```bash
61+
git push origin feature/your-feature-name
62+
```
63+
64+
## Code Style
65+
66+
- Follow PEP 8 guidelines
67+
- Use type hints where appropriate
68+
- Keep functions focused and well-documented
69+
- Maximum line length: 100 characters
70+
71+
## Priority Areas
72+
73+
We especially welcome contributions in these areas:
74+
75+
- **P0-P1**: Link upload, file processing (documents, images, audio, video)
76+
- **P2-P3**: MCP/API integrations (Notion, Obsidian, Figma), meeting recording
77+
- **P4-P5**: Mobile screenshot monitoring, smart device sync
78+
79+
See the [Context Sources](README.md#-context-source) section for more details.
80+
81+
## Community
82+
83+
- **Issues**: [GitHub Issues](https://github.com/volcengine/MineContext/issues)
84+
- **WeChat/Lark**: [Join our group](https://bytedance.larkoffice.com/wiki/Hg6VwrxnTiXtWUkgHexcFTqrnpg)
85+
- **Discord**: [Join here](https://discord.gg/tGj7RQ3nUR)
86+
87+
## License
88+
89+
By contributing, you agree that your contributions will be licensed under the [Apache 2.0 License](LICENSE).

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ opencontext/
247247
- Multi-modal content processing (text, images)
248248
5. **Storage Layer** (`storage/`)
249249

250-
- Multi-backend support (SQLite, ChromaDB, VikingDB)
250+
- Multi-backend support (SQLite, ChromaDB)
251251
- Vector storage for similarity search
252252
- Unified storage interface
253253
6. **LLM Integration** (`llm/`)

README_zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ opencontext/
247247
- 多模态内容处理(文本、图像)
248248
5. **存储层** (`storage/`)
249249

250-
- 多后端支持(SQLite、ChromaDB、VikingDB
250+
- 多后端支持(SQLite、ChromaDB)
251251
- 用于相似性搜索的向量存储
252252
- 统一的存储接口
253253
6. **LLM集成** (`llm/`)

opencontext/models/__init__.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
from opencontext.models.enums import (
1111
ContextSource,
1212
ContentFormat,
13-
ExtractedTags,
1413
)
1514
from opencontext.models.context import (
1615
RawContextProperties,
@@ -26,5 +25,4 @@
2625
"ContextProperties",
2726
"ContextSource",
2827
"ContentFormat",
29-
"ExtractedTags",
3028
]

opencontext/models/enums.py

Lines changed: 0 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -74,72 +74,6 @@ class ContentFormat(str, Enum):
7474
VECTOR = "vector"
7575

7676

77-
class ProcessingStage(str, Enum):
78-
"""Processing stage enumeration"""
79-
80-
# Raw data, unprocessed
81-
RAW = "raw"
82-
83-
# Preprocessing stage, such as text extraction, format conversion, etc.
84-
PREPROCESSED = "preprocessed"
85-
86-
# Information extraction
87-
EXTRACTED = "extracted"
88-
89-
# Classification
90-
CLASSIFIED = "classified"
91-
92-
# Summarization
93-
SUMMARIZED = "summarized"
94-
95-
# Embedding vector
96-
EMBEDDED = "embedded"
97-
98-
# Final processing stage, all processing completed
99-
FULLY_PROCESSED = "fully_processed"
100-
101-
class ExtractedTags(str, Enum):
102-
"""Extracted tags enumeration"""
103-
WORK = "work"
104-
LIFE = "life"
105-
STUDY = "study"
106-
FINANCE = "finance"
107-
ENTERTAINMENT = "entertainment"
108-
UNKNOWN = "unknown"
109-
110-
class StorageBackendType(str, Enum):
111-
"""Storage backend type enumeration"""
112-
113-
# VikingDB, for vector storage
114-
VIKINGDB = "vikingdb"
115-
116-
# File system storage
117-
FILESYSTEM = "filesystem"
118-
119-
# Memory storage (for testing)
120-
MEMORY = "memory"
121-
122-
class EntityType(str, Enum):
123-
"""Entity type enumeration"""
124-
ENTITY_NAME = "ENTITY_NAME" # Entity name
125-
FILE_NAME = "FILE_NAME" # File name
126-
DATE_RANGE = "DATE_RANGE" # Date range
127-
KEYWORD = "KEYWORD" # Keyword
128-
129-
class FilterKey(str, Enum):
130-
"""Query filter key enumeration"""
131-
CONTEXT_TYPE = "context_type"
132-
SOURCE = "source"
133-
CREATE_TIME = "create_time"
134-
UPDATE_TIME = "update_time"
135-
ENTITYS = "entities"
136-
137-
class QueryModifierKey(str, Enum):
138-
"""Query modifier key enumeration"""
139-
SIMILARITY_THRESHOLD = "similarity_threshold"
140-
RECENCY = "recency"
141-
IMPORTANCE = "importance"
142-
14377
class MergeType(str, Enum):
14478
"""Merge type enumeration"""
14579
ASSOCIATIVE = "associative"

0 commit comments

Comments
 (0)