Update Wall-X to 1.1.0 (#104)
This commit is contained in:
+23
-6
@@ -1,17 +1,34 @@
|
||||
# Contributing to Wall-x
|
||||
# Contributing to Wall-X
|
||||
|
||||
## Submit a Pull Request
|
||||
Thanks for your interest in contributing to Wall-X.
|
||||
|
||||
Before opening a pull request, please make sure your code passes the lint checks.
|
||||
## Development Setup
|
||||
|
||||
Install the project dependencies and the package in editable mode:
|
||||
|
||||
```bash
|
||||
# Install pre-commit hooks (run once)
|
||||
pip install -r requirements.txt
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
Install pre-commit hooks:
|
||||
|
||||
```bash
|
||||
pip install pre-commit
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
Or
|
||||
Run checks before opening a pull request:
|
||||
|
||||
```bash
|
||||
# Manually run all checks
|
||||
pre-commit run --all-files
|
||||
python -m pytest tests -q
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
Reference in New Issue
Block a user