modelfuzz 0.1.0__tar.gz → 0.1.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- modelfuzz-0.1.1/CONTRIBUTING.md +46 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/PKG-INFO +1 -1
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/pyproject.toml +1 -1
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/.claude/settings.local.json +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/.github/workflows/ci.yml +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/.gitignore +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/.pre-commit-config.yaml +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/LICENSE +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/README.md +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/demo.py +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/src/modelfuzz/__init__.py +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/src/modelfuzz/cli.py +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/src/modelfuzz/decorator.py +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/src/modelfuzz/engine.py +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/src/modelfuzz/exceptions.py +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/src/modelfuzz/rules.py +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/tests/test_decorator.py +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/tests/test_engine.py +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/tests/test_rules.py +0 -0
- {modelfuzz-0.1.0 → modelfuzz-0.1.1}/uv.lock +0 -0
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Contributing to ModelFuzz
|
|
2
|
+
|
|
3
|
+
Thanks for your interest in contributing. This document covers how to set up a development environment, run tests, and submit changes.
|
|
4
|
+
|
|
5
|
+
## Development Setup
|
|
6
|
+
|
|
7
|
+
ModelFuzz uses [uv](https://github.com/astral-sh/uv) for dependency management.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
git clone https://github.com/higagan/modelfuzz.git
|
|
11
|
+
cd modelfuzz
|
|
12
|
+
uv sync
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
This installs the package and its dependencies, including dev tools (`pytest`, `ruff`), into a local virtual environment.
|
|
16
|
+
|
|
17
|
+
## Running Tests
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
uv run pytest
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Tests live under [tests/](tests/) and are organized by module (`test_decorator.py`, `test_engine.py`, `test_rules.py`). Add tests alongside the code they cover, and make sure new policies or behaviors are exercised by at least one test.
|
|
24
|
+
|
|
25
|
+
## Linting
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
uv run ruff check .
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
CI runs lint and tests against Python 3.10, 3.11, and 3.12 on every push and pull request (see [.github/workflows/ci.yml](.github/workflows/ci.yml)). Please make sure both pass locally before opening a PR.
|
|
32
|
+
|
|
33
|
+
## Submitting Changes
|
|
34
|
+
|
|
35
|
+
1. Fork the repository and create a branch from `main`.
|
|
36
|
+
2. Make your changes, with tests covering new behavior.
|
|
37
|
+
3. Run `uv run ruff check .` and `uv run pytest` locally.
|
|
38
|
+
4. Open a pull request describing the change and its motivation.
|
|
39
|
+
|
|
40
|
+
## Reporting Issues
|
|
41
|
+
|
|
42
|
+
Use [GitHub Issues](https://github.com/higagan/modelfuzz/issues) to report bugs or propose features. Include a minimal reproduction where possible.
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
By contributing, you agree that your contributions will be licensed under the project's [MIT License](LICENSE).
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|