Files

35 lines
749 B
Markdown
Raw Permalink Normal View History

2026-06-15 11:40:00 +08:00
# Contributing to Wall-X
2025-09-11 13:18:33 +08:00
2026-06-15 11:40:00 +08:00
Thanks for your interest in contributing to Wall-X.
2025-09-11 13:18:33 +08:00
2026-06-15 11:40:00 +08:00
## Development Setup
Install the project dependencies and the package in editable mode:
2025-09-11 13:18:33 +08:00
```bash
2026-06-15 11:40:00 +08:00
pip install -r requirements.txt
pip install -e .
```
Install pre-commit hooks:
```bash
pip install pre-commit
2025-09-11 13:18:33 +08:00
pre-commit install
```
2026-06-15 11:40:00 +08:00
Run checks before opening a pull request:
2025-09-11 13:18:33 +08:00
```bash
pre-commit run --all-files
2026-06-15 11:40:00 +08:00
python -m pytest tests -q
2025-09-11 13:18:33 +08:00
```
2026-06-15 11:40:00 +08:00
## Pull Requests
- Keep changes focused and include reproduction steps for bug fixes.
- Update documentation when changing user-facing behavior or commands.
- Do not include private paths, credentials, internal service URLs, or large
checkpoint artifacts.
- Use placeholder paths such as `<path/to/checkpoint>` in examples.