Skip to content

Commit 4cee1ce

Browse files
ril3yclaude
andcommitted
docs: update README version references to 1.1.1, add missing documentation
- Update version references from 1.0.0 to 1.1.1 in README - Fix .gitignore: remove blanket *.md ignore that blocked all documentation - Add .gitignore entries for debug scripts, test artifacts, certificates, data dirs - Remove tracked test/debug scripts (test_duplicate_slots, test_location_rename_issue, test_websocket_live) - Create missing documentation files referenced in README: CONTRIBUTING.md, DOCKER.md, MakerMatrix/api.md, docs/CONFIGURATION.md, docs/FEATURES.md, docs/INSTALLATION.md, scripts/HTTPS_SETUP.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 674b1fd commit 4cee1ce

13 files changed

Lines changed: 928 additions & 855 deletions

.gitignore

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
1-
# Documentation files (except root README.md and CLAUDE.md)
2-
*.md
3-
**/*.md
4-
!/README.md
5-
!/CLAUDE.md
6-
71
# Claude Code configuration (user-specific)
82
.claude/
3+
CLAUDE.md
94

105
# Byte-compiled / optimized / DLL files
116
__pycache__/
@@ -266,3 +261,19 @@ MakerMatrix/backups/
266261
*.zip
267262
.env
268263
venv_ci_test/
264+
265+
# Debug and test scripts (not part of the test suite)
266+
scripts/debug_*
267+
scripts/test_*
268+
scripts/verify_*
269+
test_output.txt
270+
271+
# Security certificates and keystores
272+
*.pfx
273+
274+
# Data and storage directories (generated at runtime)
275+
data/
276+
secure_storage/
277+
278+
# Windows artifacts
279+
nul

CLAUDE.md

Lines changed: 0 additions & 148 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributing to MakerMatrix
2+
3+
We welcome contributions! Whether it's bug reports, feature requests, code contributions, or documentation improvements.
4+
5+
## Getting Started
6+
7+
1. Fork the repository
8+
2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/MakerMatrix.git`
9+
3. Create a feature branch: `git checkout -b feature/amazing-feature`
10+
4. Set up your development environment (see below)
11+
12+
## Development Setup
13+
14+
### Backend (Python 3.12+)
15+
16+
```bash
17+
python3 -m venv venv_test
18+
source venv_test/bin/activate # Windows: venv_test\Scripts\activate
19+
pip install -r requirements.txt
20+
pip install -r dev-requirements.txt
21+
```
22+
23+
### Frontend (Node 18+)
24+
25+
```bash
26+
cd MakerMatrix/frontend
27+
npm ci
28+
```
29+
30+
### Running the Development Server
31+
32+
```bash
33+
# Recommended: uses the TUI development manager
34+
python dev_manager.py
35+
36+
# Or manually:
37+
# Terminal 1 - Backend
38+
uvicorn MakerMatrix.main:app --reload --host 127.0.0.1 --port 8000
39+
40+
# Terminal 2 - Frontend
41+
cd MakerMatrix/frontend && npm run dev
42+
```
43+
44+
## Code Quality Standards
45+
46+
### Backend
47+
48+
- **Formatting**: Black with 120-character line length
49+
- **Type checking**: mypy
50+
- **Linting**: Pylint
51+
52+
```bash
53+
black --check MakerMatrix/
54+
mypy MakerMatrix/
55+
pylint MakerMatrix/
56+
```
57+
58+
### Frontend
59+
60+
- **Zero warnings policy**: ESLint must produce 0 warnings
61+
- **Formatting**: Prettier
62+
- **Type safety**: Strict TypeScript (no `any` types)
63+
64+
```bash
65+
cd MakerMatrix/frontend
66+
npm run quality # Run all checks
67+
npm run quality:fix # Auto-fix all issues
68+
```
69+
70+
## Testing
71+
72+
### Backend Tests
73+
74+
```bash
75+
pytest # Unit tests (excludes integration)
76+
pytest tests/test_specific_file.py # Single file
77+
pytest -m integration # Integration tests only
78+
pytest --cov=MakerMatrix tests/ # With coverage
79+
```
80+
81+
### Frontend Tests
82+
83+
```bash
84+
cd MakerMatrix/frontend
85+
npm run test:run # Unit tests (single run)
86+
npm run test:coverage # With coverage
87+
npm run test:e2e # Playwright E2E tests
88+
```
89+
90+
## Architecture
91+
92+
The backend follows a layered architecture:
93+
94+
```
95+
Routes → Services → Repositories → Models → Database
96+
```
97+
98+
- **routers/**: FastAPI route handlers
99+
- **services/data/**: Business logic
100+
- **services/system/**: Infrastructure services
101+
- **repositories/**: Data access layer
102+
- **models/**: SQLModel database models
103+
104+
The frontend uses:
105+
- **Zustand** for state management (`src/store/`)
106+
- **React Query** for server state (`@tanstack/react-query`)
107+
- **Axios** services in `src/services/`
108+
- **Zod** for validation (`src/schemas/`)
109+
110+
## Pull Request Guidelines
111+
112+
1. Keep PRs focused on a single change
113+
2. Add tests for new functionality
114+
3. Ensure all checks pass (`npm run quality` and `pytest`)
115+
4. Update documentation if adding/changing features
116+
5. Write clear commit messages describing the "why"
117+
118+
## Reporting Issues
119+
120+
Use [GitHub Issues](https://github.com/ril3y/MakerMatrix/issues) to report bugs or request features. Include:
121+
- Steps to reproduce (for bugs)
122+
- Expected vs actual behavior
123+
- Environment details (OS, browser, Python/Node versions)
124+
125+
## License
126+
127+
By contributing, you agree that your contributions will be licensed under the MIT License.

0 commit comments

Comments
 (0)